diff --git a/.dockerignore b/.dockerignore deleted file mode 100644 index ee07c756..00000000 --- a/.dockerignore +++ /dev/null @@ -1,46 +0,0 @@ -# See https://help.github.com/articles/ignoring-files/ for more about ignoring files. - -# dependencies -**/node_modules/ -.pnp/ -.pnp.* -npm-debug.log* -.pnpm-debug.log* -yarn-debug.log* -yarn-error.log* -.yarn/* -!.yarn/patches -!.yarn/releases -!.yarn/plugins -!.yarn/sdks -!.yarn/versions - -# testing -coverage/ -.eslintcache - -# builds -out/ -build/ -dist/ -.turbo/ -.next/ -.docusaurus/ - -# files -.DS_Store -*.pem -*.env -.env*.local -*.log -coverage.json - -# typescript -*.tsbuildinfo -next-env.d.ts -.idea/ -.vscode/ - -# Ignore the docker related files -docker/*.Dockerfile -docker/compose.yaml \ No newline at end of file diff --git a/.github/workflows/ci-default.yml b/.github/workflows/ci-default.yml index d51e1f94..37fab326 100644 --- a/.github/workflows/ci-default.yml +++ b/.github/workflows/ci-default.yml @@ -1,21 +1,8 @@ # NOTE: This name appears in GitHub's Checks API and in workflow's status badge. name: ci-default env: - TURBO_TEAM: ${{ secrets.TURBO_TEAM }} - TURBO_TOKEN: ${{ secrets.TURBO_TOKEN }} - NEXT_PUBLIC_DOMAIN: ${{ vars.NEXT_PUBLIC_DOMAIN }} - NEXT_PUBLIC_DEFAULT_CHAIN_ID: ${{ vars.NEXT_PUBLIC_DEFAULT_CHAIN_ID }} - NEXT_PUBLIC_CONTRACT_ADDRESS: ${{ vars.NEXT_PUBLIC_CONTRACT_ADDRESS }} - NEXT_PUBLIC_GRAPH_URL: ${{ vars.NEXT_PUBLIC_GRAPH_URL }} - NEXT_PUBLIC_NFT_STORAGE_TOKEN: ${{ secrets.NEXT_PUBLIC_NFT_STORAGE_TOKEN }} - NEXT_PUBLIC_WEB3_STORAGE_TOKEN: ${{ secrets.NEXT_PUBLIC_NFT_STORAGE_TOKEN }} - NEXT_PUBLIC_SUPABASE_URL: ${{ vars.NEXT_PUBLIC_SUPABASE_URL }} - NEXT_PUBLIC_SUPABASE_ANON_KEY: ${{ secrets.NEXT_PUBLIC_SUPABASE_ANON_KEY }} - NEXT_PUBLIC_SUPABASE_TABLE: ${{ vars.NEXT_PUBLIC_SUPABASE_TABLE }} - NEXT_PUBLIC_WALLETCONNECT_ID: ${{ secrets.NEXT_PUBLIC_WALLETCONNECT_ID }} INFURA_API_KEY: ${{ secrets.INFURA_API_KEY }} ALCHEMY_API_KEY: ${{ secrets.ALCHEMY_API_KEY }} - DOCKER_PLATFORM: "amd64" # Trigger the workflow when: on: @@ -46,14 +33,9 @@ jobs: # Fetch all history so gitlint can check the relevant commits. fetch-depth: "0" - run: corepack enable - - name: Set up Python 3 - uses: actions/setup-python@v4 - with: - python-version: "3.x" - name: Set up Node.js 18 uses: actions/setup-node@v4 with: - node-version: "18.18.1" cache: "pnpm" - name: Install Foundry diff --git a/.github/workflows/deploy-cors-proxy.yml b/.github/workflows/deploy-cors-proxy.yml deleted file mode 100644 index 32e1a9ad..00000000 --- a/.github/workflows/deploy-cors-proxy.yml +++ /dev/null @@ -1,33 +0,0 @@ -# NOTE: This name appears in GitHub's Checks API and in workflow's status badge. -name: deploy-cors-proxy -env: - CLOUDFLARE_API_TOKEN: ${{ secrets.CLOUDFLARE_API_TOKEN }} - -# Trigger the workflow when: -on: - # A push occurs to one of the matched branches. - push: - branches: - - main - paths: - - cors-proxy/** - # Allows you to run this workflow manually from the Actions tab - workflow_dispatch: - -jobs: - deploy-cors-proxy: - # NOTE: This name appears in GitHub's Checks API. - name: deploy-cors-proxy - environment: deploy - runs-on: ubuntu-latest - steps: - - name: Checkout code - uses: actions/checkout@v4 - with: - fetch-depth: 1 - - name: Publish - uses: cloudflare/wrangler-action@2.0.0 - with: - apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }} - workingDirectory: 'cors-proxy' - command: publish \ No newline at end of file diff --git a/.github/workflows/deploy-graph.yml b/.github/workflows/deploy-graph.yml deleted file mode 100644 index a282b660..00000000 --- a/.github/workflows/deploy-graph.yml +++ /dev/null @@ -1,40 +0,0 @@ -# NOTE: This name appears in GitHub's Checks API and in workflow's status badge. -name: deploy-graph -env: - SUBGRAPH_ACCESS_TOKEN: ${{ secrets.SUBGRAPH_ACCESS_TOKEN }} - -# Trigger the workflow when: -on: - # Allows you to run this workflow manually from the Actions tab - workflow_dispatch: - -jobs: - deploy-graph: - # NOTE: This name appears in GitHub's Checks API. - name: deploy-graph - environment: deploy - runs-on: ubuntu-latest - steps: - - name: Checkout code - uses: actions/checkout@v4 - with: - fetch-depth: 1 - - name: Setup pnpm - uses: pnpm/action-setup@v4 - with: - version: 9.1.1 - - name: Set up Node.js 18.18.1 - uses: actions/setup-node@v4 - with: - node-version: "18.18.1" - cache: "pnpm" - - name: Install - run: pnpm install --frozen-lockfile - - name: Build the subgraph - run: pnpm run build:graph - - name: Deploy the subgraph to testnets - if: github.ref == 'refs/heads/develop' - run: pnpm run deploy:graph:test - - name: Deploy the subgraph to production - if: github.ref == 'refs/heads/main' - run: pnpm run deploy:graph:prod diff --git a/.github/workflows/docker-deps.yml b/.github/workflows/docker-deps.yml deleted file mode 100644 index d4a3c204..00000000 --- a/.github/workflows/docker-deps.yml +++ /dev/null @@ -1,44 +0,0 @@ -# Builds and pushes docker dependencies used in the hypercerts docker-compose. -name: docker-deps - -on: - workflow_dispatch: - inputs: - script_name: - description: name of the docker script to execute (without the .sh) - required: true - type: string - -env: - DOCKER_PLATFORM: amd64 - REGISTRY: ghcr.io - -jobs: - docker-build-and-push: - runs-on: ubuntu-latest - steps: - - name: Checkout - uses: actions/checkout@v3 - - - name: Log in to the Container registry - uses: docker/login-action@v2 - with: - registry: ${{ env.REGISTRY }} - username: ${{ github.actor }} - password: ${{ secrets.GITHUB_TOKEN }} - - - name: run build base - run: | - bash "docker/scripts/build-base.sh" - - - name: run build script - run: | - bash "docker/scripts/build-playwright.sh" - - - name: run build graph-deps - run: | - bash "docker/scripts/build-graph-dependencies.sh" - - - name: run build graph - run: | - bash "docker/scripts/build-graph.sh" diff --git a/.github/workflows/e2e-tests.yml b/.github/workflows/e2e-tests.yml deleted file mode 100644 index 8a81eda9..00000000 --- a/.github/workflows/e2e-tests.yml +++ /dev/null @@ -1,73 +0,0 @@ -# NOTE: This name appears in GitHub's Checks API and in workflow's status badge. -name: end-to-end tests -env: - PLASMIC_PROJECT_ID: ${{ vars.PLASMIC_PROJECT_ID }} - PLASMIC_PROJECT_API_TOKEN: ${{ vars.PLASMIC_PROJECT_API_TOKEN }} - NEXT_PUBLIC_NFT_STORAGE_TOKEN: ${{ secrets.NEXT_PUBLIC_NFT_STORAGE_TOKEN }} - NEXT_PUBLIC_WEB3_STORAGE_TOKEN: ${{ secrets.NEXT_PUBLIC_NFT_STORAGE_TOKEN }} - NEXT_PUBLIC_SUPABASE_URL: ${{ vars.NEXT_PUBLIC_SUPABASE_URL }} - NEXT_PUBLIC_SUPABASE_ANON_KEY: ${{ secrets.NEXT_PUBLIC_SUPABASE_ANON_KEY }} - NEXT_PUBLIC_SUPABASE_TABLE: ${{ vars.NEXT_PUBLIC_SUPABASE_TABLE }} - NEXT_PUBLIC_WALLETCONNECT_ID: ${{ secrets.NEXT_PUBLIC_WALLETCONNECT_ID }} - DOCKER_PLATFORM: amd64 - -# Trigger the workflow when: -on: - # Allows you to run this workflow manually from the Actions tab - workflow_dispatch: - -# Cancel in progress jobs on new pushes. -concurrency: - group: ${{ github.workflow }}-${{ github.ref }} - cancel-in-progress: true - -jobs: - e2e-tests: - name: e2e-tests - environment: testing - runs-on: ubuntu-latest - steps: - - name: Checkout code - uses: actions/checkout@v3 - with: - # Check out pull request's HEAD commit instead of the merge commit to - # prevent gitlint from failing due to too long commit message titles, - # e.g. "Merge 3e621938d65caaa67f8e35d145335d889d470fc8 into 19a39b2f66cd7a165082d1486b2f1eb36ec2354a". - ref: ${{ github.event.pull_request.head.sha }} - # Fetch all history so gitlint can check the relevant commits. - fetch-depth: "0" - - uses: KengoTODA/actions-setup-docker-compose@v1 - with: - version: '2.18.1' - - - name: Set up Node.js 18 - uses: actions/setup-node@v3 - with: - node-version: "18.15.0" - cache: "yarn" - - - name: Run e2e tests - run: | - env && yarn e2e:ci-run-tests - - - name: Output logs - if: always() - run: | - yarn e2e:ci-logs > e2e.ci.log - - - name: Save logs - if: always() - uses: actions/upload-artifact@v3 - with: - name: e2e.ci.log - path: e2e.ci.log - retention-days: 3 - - - name: Save any test-results - if: always() - uses: actions/upload-artifact@v3 - with: - name: e2e-test-results - path: test-results/ - retention-days: 3 - \ No newline at end of file diff --git a/docs/docs/developer/api/index.md b/.gitmodules similarity index 100% rename from docs/docs/developer/api/index.md rename to .gitmodules diff --git a/contracts/.env.example b/contracts/.env.example index 3aa2b8d9..62f14d9f 100644 --- a/contracts/.env.example +++ b/contracts/.env.example @@ -13,6 +13,7 @@ ETHERSCAN_API_KEY="zzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz" OPTIMISTIC_ETHERSCAN_API_KEY="zzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz" CELOSCAN_API_KEY="zzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz" BASESCAN_API_KEY="zzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz" +ARBISCAN_API_KEY="zzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz" # Unused, ignore below REPORT_GAS=false diff --git a/contracts/.eslintrc.yml b/contracts/.eslintrc.yml index bc63dc32..d6865cde 100644 --- a/contracts/.eslintrc.yml +++ b/contracts/.eslintrc.yml @@ -5,6 +5,6 @@ extends: - "prettier" parser: "@typescript-eslint/parser" parserOptions: - project: "./contracts/tsconfig.json" + project: "./tsconfig.json" plugins: - "@typescript-eslint" diff --git a/contracts/.openzeppelin/arbitrum-one.json b/contracts/.openzeppelin/arbitrum-one.json new file mode 100644 index 00000000..b47aa5fe --- /dev/null +++ b/contracts/.openzeppelin/arbitrum-one.json @@ -0,0 +1,378 @@ +{ + "manifestVersion": "3.2", + "proxies": [ + { + "address": "0x822F17A9A5EeCFd66dBAFf7946a8071C265D1d07", + "txHash": "0xa020df8805f0275dd701a7ed7eeb89dbe257f4ccf143d5429d0321daa5d8c55b", + "kind": "uups" + } + ], + "impls": { + "125db54394ee349f18c5e7b6f717dff5868c4ccab68a96eeef38a6321b3f05b2": { + "address": "0xc6FbcFE16D5eBFEd21aCe224C49C94dE49046A04", + "txHash": "0xca34a4f91320396382c7afc64e0e4300ff5b421eb1d61dceaf33da8bc66e5964", + "layout": { + "solcVersion": "0.8.17", + "storage": [ + { + "label": "_initialized", + "offset": 0, + "slot": "0", + "type": "t_uint8", + "contract": "Initializable", + "src": "lib/openzeppelin-contracts-upgradeable/contracts/proxy/utils/Initializable.sol:62", + "retypedFrom": "bool" + }, + { + "label": "_initializing", + "offset": 1, + "slot": "0", + "type": "t_bool", + "contract": "Initializable", + "src": "lib/openzeppelin-contracts-upgradeable/contracts/proxy/utils/Initializable.sol:67" + }, + { + "label": "__gap", + "offset": 0, + "slot": "1", + "type": "t_array(t_uint256)50_storage", + "contract": "ContextUpgradeable", + "src": "lib/openzeppelin-contracts-upgradeable/contracts/utils/ContextUpgradeable.sol:36" + }, + { + "label": "__gap", + "offset": 0, + "slot": "51", + "type": "t_array(t_uint256)50_storage", + "contract": "ERC165Upgradeable", + "src": "lib/openzeppelin-contracts-upgradeable/contracts/utils/introspection/ERC165Upgradeable.sol:41" + }, + { + "label": "_balances", + "offset": 0, + "slot": "101", + "type": "t_mapping(t_uint256,t_mapping(t_address,t_uint256))", + "contract": "ERC1155Upgradeable", + "src": "lib/openzeppelin-contracts-upgradeable/contracts/token/ERC1155/ERC1155Upgradeable.sol:25" + }, + { + "label": "_operatorApprovals", + "offset": 0, + "slot": "102", + "type": "t_mapping(t_address,t_mapping(t_address,t_bool))", + "contract": "ERC1155Upgradeable", + "src": "lib/openzeppelin-contracts-upgradeable/contracts/token/ERC1155/ERC1155Upgradeable.sol:28" + }, + { + "label": "_uri", + "offset": 0, + "slot": "103", + "type": "t_string_storage", + "contract": "ERC1155Upgradeable", + "src": "lib/openzeppelin-contracts-upgradeable/contracts/token/ERC1155/ERC1155Upgradeable.sol:31" + }, + { + "label": "__gap", + "offset": 0, + "slot": "104", + "type": "t_array(t_uint256)47_storage", + "contract": "ERC1155Upgradeable", + "src": "lib/openzeppelin-contracts-upgradeable/contracts/token/ERC1155/ERC1155Upgradeable.sol:528" + }, + { + "label": "__gap", + "offset": 0, + "slot": "151", + "type": "t_array(t_uint256)50_storage", + "contract": "ERC1155BurnableUpgradeable", + "src": "lib/openzeppelin-contracts-upgradeable/contracts/token/ERC1155/extensions/ERC1155BurnableUpgradeable.sol:52" + }, + { + "label": "_baseURI", + "offset": 0, + "slot": "201", + "type": "t_string_storage", + "contract": "ERC1155URIStorageUpgradeable", + "src": "lib/openzeppelin-contracts-upgradeable/contracts/token/ERC1155/extensions/ERC1155URIStorageUpgradeable.sol:27" + }, + { + "label": "_tokenURIs", + "offset": 0, + "slot": "202", + "type": "t_mapping(t_uint256,t_string_storage)", + "contract": "ERC1155URIStorageUpgradeable", + "src": "lib/openzeppelin-contracts-upgradeable/contracts/token/ERC1155/extensions/ERC1155URIStorageUpgradeable.sol:30" + }, + { + "label": "__gap", + "offset": 0, + "slot": "203", + "type": "t_array(t_uint256)48_storage", + "contract": "ERC1155URIStorageUpgradeable", + "src": "lib/openzeppelin-contracts-upgradeable/contracts/token/ERC1155/extensions/ERC1155URIStorageUpgradeable.sol:77" + }, + { + "label": "_owner", + "offset": 0, + "slot": "251", + "type": "t_address", + "contract": "OwnableUpgradeable", + "src": "lib/openzeppelin-contracts-upgradeable/contracts/access/OwnableUpgradeable.sol:22" + }, + { + "label": "__gap", + "offset": 0, + "slot": "252", + "type": "t_array(t_uint256)49_storage", + "contract": "OwnableUpgradeable", + "src": "lib/openzeppelin-contracts-upgradeable/contracts/access/OwnableUpgradeable.sol:94" + }, + { + "label": "__gap", + "offset": 0, + "slot": "301", + "type": "t_array(t_uint256)50_storage", + "contract": "ERC1967UpgradeUpgradeable", + "src": "lib/openzeppelin-contracts-upgradeable/contracts/proxy/ERC1967/ERC1967UpgradeUpgradeable.sol:211" + }, + { + "label": "__gap", + "offset": 0, + "slot": "351", + "type": "t_array(t_uint256)50_storage", + "contract": "UUPSUpgradeable", + "src": "lib/openzeppelin-contracts-upgradeable/contracts/proxy/utils/UUPSUpgradeable.sol:107" + }, + { + "label": "typeCounter", + "offset": 0, + "slot": "401", + "type": "t_uint256", + "contract": "SemiFungible1155", + "src": "src/protocol/SemiFungible1155.sol:27" + }, + { + "label": "owners", + "offset": 0, + "slot": "402", + "type": "t_mapping(t_uint256,t_address)", + "contract": "SemiFungible1155", + "src": "src/protocol/SemiFungible1155.sol:38" + }, + { + "label": "creators", + "offset": 0, + "slot": "403", + "type": "t_mapping(t_uint256,t_address)", + "contract": "SemiFungible1155", + "src": "src/protocol/SemiFungible1155.sol:41" + }, + { + "label": "tokenValues", + "offset": 0, + "slot": "404", + "type": "t_mapping(t_uint256,t_uint256)", + "contract": "SemiFungible1155", + "src": "src/protocol/SemiFungible1155.sol:44" + }, + { + "label": "maxIndex", + "offset": 0, + "slot": "405", + "type": "t_mapping(t_uint256,t_uint256)", + "contract": "SemiFungible1155", + "src": "src/protocol/SemiFungible1155.sol:47" + }, + { + "label": "__gap", + "offset": 0, + "slot": "406", + "type": "t_array(t_uint256)25_storage", + "contract": "SemiFungible1155", + "src": "src/protocol/SemiFungible1155.sol:648" + }, + { + "label": "merkleRoots", + "offset": 0, + "slot": "431", + "type": "t_mapping(t_uint256,t_bytes32)", + "contract": "AllowlistMinter", + "src": "src/protocol/AllowlistMinter.sol:17" + }, + { + "label": "hasBeenClaimed", + "offset": 0, + "slot": "432", + "type": "t_mapping(t_uint256,t_mapping(t_bytes32,t_bool))", + "contract": "AllowlistMinter", + "src": "src/protocol/AllowlistMinter.sol:18" + }, + { + "label": "maxUnits", + "offset": 0, + "slot": "433", + "type": "t_mapping(t_uint256,t_uint256)", + "contract": "AllowlistMinter", + "src": "src/protocol/AllowlistMinter.sol:19" + }, + { + "label": "minted", + "offset": 0, + "slot": "434", + "type": "t_mapping(t_uint256,t_uint256)", + "contract": "AllowlistMinter", + "src": "src/protocol/AllowlistMinter.sol:20" + }, + { + "label": "__gap", + "offset": 0, + "slot": "435", + "type": "t_array(t_uint256)26_storage", + "contract": "AllowlistMinter", + "src": "src/protocol/AllowlistMinter.sol:75" + }, + { + "label": "_paused", + "offset": 0, + "slot": "461", + "type": "t_bool", + "contract": "PausableUpgradeable", + "src": "lib/openzeppelin-contracts-upgradeable/contracts/security/PausableUpgradeable.sol:29" + }, + { + "label": "__gap", + "offset": 0, + "slot": "462", + "type": "t_array(t_uint256)49_storage", + "contract": "PausableUpgradeable", + "src": "lib/openzeppelin-contracts-upgradeable/contracts/security/PausableUpgradeable.sol:116" + }, + { + "label": "typeRestrictions", + "offset": 0, + "slot": "511", + "type": "t_mapping(t_uint256,t_enum(TransferRestrictions)19595)", + "contract": "HypercertMinter", + "src": "src/protocol/HypercertMinter.sol:20" + }, + { + "label": "__gap", + "offset": 0, + "slot": "512", + "type": "t_array(t_uint256)29_storage", + "contract": "HypercertMinter", + "src": "src/protocol/HypercertMinter.sol:258" + } + ], + "types": { + "t_address": { + "label": "address", + "numberOfBytes": "20" + }, + "t_array(t_uint256)25_storage": { + "label": "uint256[25]", + "numberOfBytes": "800" + }, + "t_array(t_uint256)26_storage": { + "label": "uint256[26]", + "numberOfBytes": "832" + }, + "t_array(t_uint256)29_storage": { + "label": "uint256[29]", + "numberOfBytes": "928" + }, + "t_array(t_uint256)47_storage": { + "label": "uint256[47]", + "numberOfBytes": "1504" + }, + "t_array(t_uint256)48_storage": { + "label": "uint256[48]", + "numberOfBytes": "1536" + }, + "t_array(t_uint256)49_storage": { + "label": "uint256[49]", + "numberOfBytes": "1568" + }, + "t_array(t_uint256)50_storage": { + "label": "uint256[50]", + "numberOfBytes": "1600" + }, + "t_bool": { + "label": "bool", + "numberOfBytes": "1" + }, + "t_bytes32": { + "label": "bytes32", + "numberOfBytes": "32" + }, + "t_enum(TransferRestrictions)19595": { + "label": "enum IHypercertToken.TransferRestrictions", + "members": [ + "AllowAll", + "DisallowAll", + "FromCreatorOnly" + ], + "numberOfBytes": "1" + }, + "t_mapping(t_address,t_bool)": { + "label": "mapping(address => bool)", + "numberOfBytes": "32" + }, + "t_mapping(t_address,t_mapping(t_address,t_bool))": { + "label": "mapping(address => mapping(address => bool))", + "numberOfBytes": "32" + }, + "t_mapping(t_address,t_uint256)": { + "label": "mapping(address => uint256)", + "numberOfBytes": "32" + }, + "t_mapping(t_bytes32,t_bool)": { + "label": "mapping(bytes32 => bool)", + "numberOfBytes": "32" + }, + "t_mapping(t_uint256,t_address)": { + "label": "mapping(uint256 => address)", + "numberOfBytes": "32" + }, + "t_mapping(t_uint256,t_bytes32)": { + "label": "mapping(uint256 => bytes32)", + "numberOfBytes": "32" + }, + "t_mapping(t_uint256,t_enum(TransferRestrictions)19595)": { + "label": "mapping(uint256 => enum IHypercertToken.TransferRestrictions)", + "numberOfBytes": "32" + }, + "t_mapping(t_uint256,t_mapping(t_address,t_uint256))": { + "label": "mapping(uint256 => mapping(address => uint256))", + "numberOfBytes": "32" + }, + "t_mapping(t_uint256,t_mapping(t_bytes32,t_bool))": { + "label": "mapping(uint256 => mapping(bytes32 => bool))", + "numberOfBytes": "32" + }, + "t_mapping(t_uint256,t_string_storage)": { + "label": "mapping(uint256 => string)", + "numberOfBytes": "32" + }, + "t_mapping(t_uint256,t_uint256)": { + "label": "mapping(uint256 => uint256)", + "numberOfBytes": "32" + }, + "t_string_storage": { + "label": "string", + "numberOfBytes": "32" + }, + "t_uint256": { + "label": "uint256", + "numberOfBytes": "32" + }, + "t_uint8": { + "label": "uint8", + "numberOfBytes": "1" + } + }, + "namespaces": {} + } + } + } +} diff --git a/contracts/.openzeppelin/optimism.json b/contracts/.openzeppelin/optimism.json index 0097926c..f5240457 100644 --- a/contracts/.openzeppelin/optimism.json +++ b/contracts/.openzeppelin/optimism.json @@ -2,753 +2,15 @@ "manifestVersion": "3.2", "proxies": [ { - "address": "0x822F17A9A5EeCFd66dBAFf7946a8071C265D1d07", + "address": "0x822f17a9a5eecfd66dbaff7946a8071c265d1d07", "kind": "uups" } ], "impls": { - "5bd56aa108022a80651301eeed96e6ac20fea02040073a01f341a6c8b635d38e": { - "address": "0xc6FbcFE16D5eBFEd21aCe224C49C94dE49046A04", - "layout": { - "solcVersion": "0.8.16", - "storage": [ - { - "label": "_initialized", - "offset": 0, - "slot": "0", - "type": "t_uint8", - "contract": "Initializable", - "src": "lib/openzeppelin-contracts-upgradeable/contracts/proxy/utils/Initializable.sol:62", - "retypedFrom": "bool" - }, - { - "label": "_initializing", - "offset": 1, - "slot": "0", - "type": "t_bool", - "contract": "Initializable", - "src": "lib/openzeppelin-contracts-upgradeable/contracts/proxy/utils/Initializable.sol:67" - }, - { - "label": "__gap", - "offset": 0, - "slot": "1", - "type": "t_array(t_uint256)50_storage", - "contract": "ContextUpgradeable", - "src": "lib/openzeppelin-contracts-upgradeable/contracts/utils/ContextUpgradeable.sol:36" - }, - { - "label": "__gap", - "offset": 0, - "slot": "51", - "type": "t_array(t_uint256)50_storage", - "contract": "ERC165Upgradeable", - "src": "lib/openzeppelin-contracts-upgradeable/contracts/utils/introspection/ERC165Upgradeable.sol:41" - }, - { - "label": "_balances", - "offset": 0, - "slot": "101", - "type": "t_mapping(t_uint256,t_mapping(t_address,t_uint256))", - "contract": "ERC1155Upgradeable", - "src": "lib/openzeppelin-contracts-upgradeable/contracts/token/ERC1155/ERC1155Upgradeable.sol:25" - }, - { - "label": "_operatorApprovals", - "offset": 0, - "slot": "102", - "type": "t_mapping(t_address,t_mapping(t_address,t_bool))", - "contract": "ERC1155Upgradeable", - "src": "lib/openzeppelin-contracts-upgradeable/contracts/token/ERC1155/ERC1155Upgradeable.sol:28" - }, - { - "label": "_uri", - "offset": 0, - "slot": "103", - "type": "t_string_storage", - "contract": "ERC1155Upgradeable", - "src": "lib/openzeppelin-contracts-upgradeable/contracts/token/ERC1155/ERC1155Upgradeable.sol:31" - }, - { - "label": "__gap", - "offset": 0, - "slot": "104", - "type": "t_array(t_uint256)47_storage", - "contract": "ERC1155Upgradeable", - "src": "lib/openzeppelin-contracts-upgradeable/contracts/token/ERC1155/ERC1155Upgradeable.sol:528" - }, - { - "label": "__gap", - "offset": 0, - "slot": "151", - "type": "t_array(t_uint256)50_storage", - "contract": "ERC1155BurnableUpgradeable", - "src": "lib/openzeppelin-contracts-upgradeable/contracts/token/ERC1155/extensions/ERC1155BurnableUpgradeable.sol:52" - }, - { - "label": "_baseURI", - "offset": 0, - "slot": "201", - "type": "t_string_storage", - "contract": "ERC1155URIStorageUpgradeable", - "src": "lib/openzeppelin-contracts-upgradeable/contracts/token/ERC1155/extensions/ERC1155URIStorageUpgradeable.sol:27" - }, - { - "label": "_tokenURIs", - "offset": 0, - "slot": "202", - "type": "t_mapping(t_uint256,t_string_storage)", - "contract": "ERC1155URIStorageUpgradeable", - "src": "lib/openzeppelin-contracts-upgradeable/contracts/token/ERC1155/extensions/ERC1155URIStorageUpgradeable.sol:30" - }, - { - "label": "__gap", - "offset": 0, - "slot": "203", - "type": "t_array(t_uint256)48_storage", - "contract": "ERC1155URIStorageUpgradeable", - "src": "lib/openzeppelin-contracts-upgradeable/contracts/token/ERC1155/extensions/ERC1155URIStorageUpgradeable.sol:77" - }, - { - "label": "_owner", - "offset": 0, - "slot": "251", - "type": "t_address", - "contract": "OwnableUpgradeable", - "src": "lib/openzeppelin-contracts-upgradeable/contracts/access/OwnableUpgradeable.sol:22" - }, - { - "label": "__gap", - "offset": 0, - "slot": "252", - "type": "t_array(t_uint256)49_storage", - "contract": "OwnableUpgradeable", - "src": "lib/openzeppelin-contracts-upgradeable/contracts/access/OwnableUpgradeable.sol:94" - }, - { - "label": "__gap", - "offset": 0, - "slot": "301", - "type": "t_array(t_uint256)50_storage", - "contract": "ERC1967UpgradeUpgradeable", - "src": "lib/openzeppelin-contracts-upgradeable/contracts/proxy/ERC1967/ERC1967UpgradeUpgradeable.sol:211" - }, - { - "label": "__gap", - "offset": 0, - "slot": "351", - "type": "t_array(t_uint256)50_storage", - "contract": "UUPSUpgradeable", - "src": "lib/openzeppelin-contracts-upgradeable/contracts/proxy/utils/UUPSUpgradeable.sol:107" - }, - { - "label": "typeCounter", - "offset": 0, - "slot": "401", - "type": "t_uint256", - "contract": "SemiFungible1155", - "src": "src/SemiFungible1155.sol:27" - }, - { - "label": "owners", - "offset": 0, - "slot": "402", - "type": "t_mapping(t_uint256,t_address)", - "contract": "SemiFungible1155", - "src": "src/SemiFungible1155.sol:38" - }, - { - "label": "creators", - "offset": 0, - "slot": "403", - "type": "t_mapping(t_uint256,t_address)", - "contract": "SemiFungible1155", - "src": "src/SemiFungible1155.sol:41" - }, - { - "label": "tokenValues", - "offset": 0, - "slot": "404", - "type": "t_mapping(t_uint256,t_uint256)", - "contract": "SemiFungible1155", - "src": "src/SemiFungible1155.sol:44" - }, - { - "label": "maxIndex", - "offset": 0, - "slot": "405", - "type": "t_mapping(t_uint256,t_uint256)", - "contract": "SemiFungible1155", - "src": "src/SemiFungible1155.sol:47" - }, - { - "label": "__gap", - "offset": 0, - "slot": "406", - "type": "t_array(t_uint256)25_storage", - "contract": "SemiFungible1155", - "src": "src/SemiFungible1155.sol:433" - }, - { - "label": "merkleRoots", - "offset": 0, - "slot": "431", - "type": "t_mapping(t_uint256,t_bytes32)", - "contract": "AllowlistMinter", - "src": "src/AllowlistMinter.sol:17" - }, - { - "label": "hasBeenClaimed", - "offset": 0, - "slot": "432", - "type": "t_mapping(t_uint256,t_mapping(t_bytes32,t_bool))", - "contract": "AllowlistMinter", - "src": "src/AllowlistMinter.sol:18" - }, - { - "label": "maxUnits", - "offset": 0, - "slot": "433", - "type": "t_mapping(t_uint256,t_uint256)", - "contract": "AllowlistMinter", - "src": "src/AllowlistMinter.sol:19" - }, - { - "label": "minted", - "offset": 0, - "slot": "434", - "type": "t_mapping(t_uint256,t_uint256)", - "contract": "AllowlistMinter", - "src": "src/AllowlistMinter.sol:20" - }, - { - "label": "__gap", - "offset": 0, - "slot": "435", - "type": "t_array(t_uint256)26_storage", - "contract": "AllowlistMinter", - "src": "src/AllowlistMinter.sol:69" - }, - { - "label": "_paused", - "offset": 0, - "slot": "461", - "type": "t_bool", - "contract": "PausableUpgradeable", - "src": "lib/openzeppelin-contracts-upgradeable/contracts/security/PausableUpgradeable.sol:29" - }, - { - "label": "__gap", - "offset": 0, - "slot": "462", - "type": "t_array(t_uint256)49_storage", - "contract": "PausableUpgradeable", - "src": "lib/openzeppelin-contracts-upgradeable/contracts/security/PausableUpgradeable.sol:116" - }, - { - "label": "typeRestrictions", - "offset": 0, - "slot": "511", - "type": "t_mapping(t_uint256,t_enum(TransferRestrictions)6765)", - "contract": "HypercertMinter", - "src": "src/HypercertMinter.sol:20" - }, - { - "label": "__gap", - "offset": 0, - "slot": "512", - "type": "t_array(t_uint256)29_storage", - "contract": "HypercertMinter", - "src": "src/HypercertMinter.sol:228" - } - ], - "types": { - "t_address": { - "label": "address", - "numberOfBytes": "20" - }, - "t_array(t_uint256)25_storage": { - "label": "uint256[25]", - "numberOfBytes": "800" - }, - "t_array(t_uint256)26_storage": { - "label": "uint256[26]", - "numberOfBytes": "832" - }, - "t_array(t_uint256)29_storage": { - "label": "uint256[29]", - "numberOfBytes": "928" - }, - "t_array(t_uint256)47_storage": { - "label": "uint256[47]", - "numberOfBytes": "1504" - }, - "t_array(t_uint256)48_storage": { - "label": "uint256[48]", - "numberOfBytes": "1536" - }, - "t_array(t_uint256)49_storage": { - "label": "uint256[49]", - "numberOfBytes": "1568" - }, - "t_array(t_uint256)50_storage": { - "label": "uint256[50]", - "numberOfBytes": "1600" - }, - "t_bool": { - "label": "bool", - "numberOfBytes": "1" - }, - "t_bytes32": { - "label": "bytes32", - "numberOfBytes": "32" - }, - "t_enum(TransferRestrictions)6765": { - "label": "enum IHypercertToken.TransferRestrictions", - "members": [ - "AllowAll", - "DisallowAll", - "FromCreatorOnly" - ], - "numberOfBytes": "1" - }, - "t_mapping(t_address,t_bool)": { - "label": "mapping(address => bool)", - "numberOfBytes": "32" - }, - "t_mapping(t_address,t_mapping(t_address,t_bool))": { - "label": "mapping(address => mapping(address => bool))", - "numberOfBytes": "32" - }, - "t_mapping(t_address,t_uint256)": { - "label": "mapping(address => uint256)", - "numberOfBytes": "32" - }, - "t_mapping(t_bytes32,t_bool)": { - "label": "mapping(bytes32 => bool)", - "numberOfBytes": "32" - }, - "t_mapping(t_uint256,t_address)": { - "label": "mapping(uint256 => address)", - "numberOfBytes": "32" - }, - "t_mapping(t_uint256,t_bytes32)": { - "label": "mapping(uint256 => bytes32)", - "numberOfBytes": "32" - }, - "t_mapping(t_uint256,t_enum(TransferRestrictions)6765)": { - "label": "mapping(uint256 => enum IHypercertToken.TransferRestrictions)", - "numberOfBytes": "32" - }, - "t_mapping(t_uint256,t_mapping(t_address,t_uint256))": { - "label": "mapping(uint256 => mapping(address => uint256))", - "numberOfBytes": "32" - }, - "t_mapping(t_uint256,t_mapping(t_bytes32,t_bool))": { - "label": "mapping(uint256 => mapping(bytes32 => bool))", - "numberOfBytes": "32" - }, - "t_mapping(t_uint256,t_string_storage)": { - "label": "mapping(uint256 => string)", - "numberOfBytes": "32" - }, - "t_mapping(t_uint256,t_uint256)": { - "label": "mapping(uint256 => uint256)", - "numberOfBytes": "32" - }, - "t_string_storage": { - "label": "string", - "numberOfBytes": "32" - }, - "t_uint256": { - "label": "uint256", - "numberOfBytes": "32" - }, - "t_uint8": { - "label": "uint8", - "numberOfBytes": "1" - } - } - } - }, - "31f9c6a26cf17ca4bb624cde3829d09c9a5a4a1d419afe174e7bd6d46cc5c0d9": { - "address": "0x396D5f1EF3aa92dDAd4DEad04388374A03BC5577", - "txHash": "0xaa0093e2c748592309277ebc3f82d2a265071a11fce81822dc75bab1f2ea838e", - "layout": { - "solcVersion": "0.8.16", - "storage": [ - { - "label": "_initialized", - "offset": 0, - "slot": "0", - "type": "t_uint8", - "contract": "Initializable", - "src": "lib/openzeppelin-contracts-upgradeable/contracts/proxy/utils/Initializable.sol:62", - "retypedFrom": "bool" - }, - { - "label": "_initializing", - "offset": 1, - "slot": "0", - "type": "t_bool", - "contract": "Initializable", - "src": "lib/openzeppelin-contracts-upgradeable/contracts/proxy/utils/Initializable.sol:67" - }, - { - "label": "__gap", - "offset": 0, - "slot": "1", - "type": "t_array(t_uint256)50_storage", - "contract": "ContextUpgradeable", - "src": "lib/openzeppelin-contracts-upgradeable/contracts/utils/ContextUpgradeable.sol:36" - }, - { - "label": "__gap", - "offset": 0, - "slot": "51", - "type": "t_array(t_uint256)50_storage", - "contract": "ERC165Upgradeable", - "src": "lib/openzeppelin-contracts-upgradeable/contracts/utils/introspection/ERC165Upgradeable.sol:41" - }, - { - "label": "_balances", - "offset": 0, - "slot": "101", - "type": "t_mapping(t_uint256,t_mapping(t_address,t_uint256))", - "contract": "ERC1155Upgradeable", - "src": "lib/openzeppelin-contracts-upgradeable/contracts/token/ERC1155/ERC1155Upgradeable.sol:25" - }, - { - "label": "_operatorApprovals", - "offset": 0, - "slot": "102", - "type": "t_mapping(t_address,t_mapping(t_address,t_bool))", - "contract": "ERC1155Upgradeable", - "src": "lib/openzeppelin-contracts-upgradeable/contracts/token/ERC1155/ERC1155Upgradeable.sol:28" - }, - { - "label": "_uri", - "offset": 0, - "slot": "103", - "type": "t_string_storage", - "contract": "ERC1155Upgradeable", - "src": "lib/openzeppelin-contracts-upgradeable/contracts/token/ERC1155/ERC1155Upgradeable.sol:31" - }, - { - "label": "__gap", - "offset": 0, - "slot": "104", - "type": "t_array(t_uint256)47_storage", - "contract": "ERC1155Upgradeable", - "src": "lib/openzeppelin-contracts-upgradeable/contracts/token/ERC1155/ERC1155Upgradeable.sol:528" - }, - { - "label": "__gap", - "offset": 0, - "slot": "151", - "type": "t_array(t_uint256)50_storage", - "contract": "ERC1155BurnableUpgradeable", - "src": "lib/openzeppelin-contracts-upgradeable/contracts/token/ERC1155/extensions/ERC1155BurnableUpgradeable.sol:52" - }, - { - "label": "_baseURI", - "offset": 0, - "slot": "201", - "type": "t_string_storage", - "contract": "ERC1155URIStorageUpgradeable", - "src": "lib/openzeppelin-contracts-upgradeable/contracts/token/ERC1155/extensions/ERC1155URIStorageUpgradeable.sol:27" - }, - { - "label": "_tokenURIs", - "offset": 0, - "slot": "202", - "type": "t_mapping(t_uint256,t_string_storage)", - "contract": "ERC1155URIStorageUpgradeable", - "src": "lib/openzeppelin-contracts-upgradeable/contracts/token/ERC1155/extensions/ERC1155URIStorageUpgradeable.sol:30" - }, - { - "label": "__gap", - "offset": 0, - "slot": "203", - "type": "t_array(t_uint256)48_storage", - "contract": "ERC1155URIStorageUpgradeable", - "src": "lib/openzeppelin-contracts-upgradeable/contracts/token/ERC1155/extensions/ERC1155URIStorageUpgradeable.sol:77" - }, - { - "label": "_owner", - "offset": 0, - "slot": "251", - "type": "t_address", - "contract": "OwnableUpgradeable", - "src": "lib/openzeppelin-contracts-upgradeable/contracts/access/OwnableUpgradeable.sol:22" - }, - { - "label": "__gap", - "offset": 0, - "slot": "252", - "type": "t_array(t_uint256)49_storage", - "contract": "OwnableUpgradeable", - "src": "lib/openzeppelin-contracts-upgradeable/contracts/access/OwnableUpgradeable.sol:94" - }, - { - "label": "__gap", - "offset": 0, - "slot": "301", - "type": "t_array(t_uint256)50_storage", - "contract": "ERC1967UpgradeUpgradeable", - "src": "lib/openzeppelin-contracts-upgradeable/contracts/proxy/ERC1967/ERC1967UpgradeUpgradeable.sol:211" - }, - { - "label": "__gap", - "offset": 0, - "slot": "351", - "type": "t_array(t_uint256)50_storage", - "contract": "UUPSUpgradeable", - "src": "lib/openzeppelin-contracts-upgradeable/contracts/proxy/utils/UUPSUpgradeable.sol:107" - }, - { - "label": "typeCounter", - "offset": 0, - "slot": "401", - "type": "t_uint256", - "contract": "SemiFungible1155", - "src": "src/SemiFungible1155.sol:27" - }, - { - "label": "owners", - "offset": 0, - "slot": "402", - "type": "t_mapping(t_uint256,t_address)", - "contract": "SemiFungible1155", - "src": "src/SemiFungible1155.sol:38" - }, - { - "label": "creators", - "offset": 0, - "slot": "403", - "type": "t_mapping(t_uint256,t_address)", - "contract": "SemiFungible1155", - "src": "src/SemiFungible1155.sol:41" - }, - { - "label": "tokenValues", - "offset": 0, - "slot": "404", - "type": "t_mapping(t_uint256,t_uint256)", - "contract": "SemiFungible1155", - "src": "src/SemiFungible1155.sol:44" - }, - { - "label": "maxIndex", - "offset": 0, - "slot": "405", - "type": "t_mapping(t_uint256,t_uint256)", - "contract": "SemiFungible1155", - "src": "src/SemiFungible1155.sol:47" - }, - { - "label": "__gap", - "offset": 0, - "slot": "406", - "type": "t_array(t_uint256)25_storage", - "contract": "SemiFungible1155", - "src": "src/SemiFungible1155.sol:432" - }, - { - "label": "merkleRoots", - "offset": 0, - "slot": "431", - "type": "t_mapping(t_uint256,t_bytes32)", - "contract": "AllowlistMinter", - "src": "src/AllowlistMinter.sol:17" - }, - { - "label": "hasBeenClaimed", - "offset": 0, - "slot": "432", - "type": "t_mapping(t_uint256,t_mapping(t_bytes32,t_bool))", - "contract": "AllowlistMinter", - "src": "src/AllowlistMinter.sol:18" - }, - { - "label": "maxUnits", - "offset": 0, - "slot": "433", - "type": "t_mapping(t_uint256,t_uint256)", - "contract": "AllowlistMinter", - "src": "src/AllowlistMinter.sol:19" - }, - { - "label": "minted", - "offset": 0, - "slot": "434", - "type": "t_mapping(t_uint256,t_uint256)", - "contract": "AllowlistMinter", - "src": "src/AllowlistMinter.sol:20" - }, - { - "label": "__gap", - "offset": 0, - "slot": "435", - "type": "t_array(t_uint256)26_storage", - "contract": "AllowlistMinter", - "src": "src/AllowlistMinter.sol:69" - }, - { - "label": "_paused", - "offset": 0, - "slot": "461", - "type": "t_bool", - "contract": "PausableUpgradeable", - "src": "lib/openzeppelin-contracts-upgradeable/contracts/security/PausableUpgradeable.sol:29" - }, - { - "label": "__gap", - "offset": 0, - "slot": "462", - "type": "t_array(t_uint256)49_storage", - "contract": "PausableUpgradeable", - "src": "lib/openzeppelin-contracts-upgradeable/contracts/security/PausableUpgradeable.sol:116" - }, - { - "label": "typeRestrictions", - "offset": 0, - "slot": "511", - "type": "t_mapping(t_uint256,t_enum(TransferRestrictions)6761)", - "contract": "HypercertMinter", - "src": "src/HypercertMinter.sol:20" - }, - { - "label": "__gap", - "offset": 0, - "slot": "512", - "type": "t_array(t_uint256)29_storage", - "contract": "HypercertMinter", - "src": "src/HypercertMinter.sol:228" - } - ], - "types": { - "t_address": { - "label": "address", - "numberOfBytes": "20" - }, - "t_array(t_uint256)25_storage": { - "label": "uint256[25]", - "numberOfBytes": "800" - }, - "t_array(t_uint256)26_storage": { - "label": "uint256[26]", - "numberOfBytes": "832" - }, - "t_array(t_uint256)29_storage": { - "label": "uint256[29]", - "numberOfBytes": "928" - }, - "t_array(t_uint256)47_storage": { - "label": "uint256[47]", - "numberOfBytes": "1504" - }, - "t_array(t_uint256)48_storage": { - "label": "uint256[48]", - "numberOfBytes": "1536" - }, - "t_array(t_uint256)49_storage": { - "label": "uint256[49]", - "numberOfBytes": "1568" - }, - "t_array(t_uint256)50_storage": { - "label": "uint256[50]", - "numberOfBytes": "1600" - }, - "t_bool": { - "label": "bool", - "numberOfBytes": "1" - }, - "t_bytes32": { - "label": "bytes32", - "numberOfBytes": "32" - }, - "t_enum(TransferRestrictions)6761": { - "label": "enum IHypercertToken.TransferRestrictions", - "members": [ - "AllowAll", - "DisallowAll", - "FromCreatorOnly" - ], - "numberOfBytes": "1" - }, - "t_mapping(t_address,t_bool)": { - "label": "mapping(address => bool)", - "numberOfBytes": "32" - }, - "t_mapping(t_address,t_mapping(t_address,t_bool))": { - "label": "mapping(address => mapping(address => bool))", - "numberOfBytes": "32" - }, - "t_mapping(t_address,t_uint256)": { - "label": "mapping(address => uint256)", - "numberOfBytes": "32" - }, - "t_mapping(t_bytes32,t_bool)": { - "label": "mapping(bytes32 => bool)", - "numberOfBytes": "32" - }, - "t_mapping(t_uint256,t_address)": { - "label": "mapping(uint256 => address)", - "numberOfBytes": "32" - }, - "t_mapping(t_uint256,t_bytes32)": { - "label": "mapping(uint256 => bytes32)", - "numberOfBytes": "32" - }, - "t_mapping(t_uint256,t_enum(TransferRestrictions)6761)": { - "label": "mapping(uint256 => enum IHypercertToken.TransferRestrictions)", - "numberOfBytes": "32" - }, - "t_mapping(t_uint256,t_mapping(t_address,t_uint256))": { - "label": "mapping(uint256 => mapping(address => uint256))", - "numberOfBytes": "32" - }, - "t_mapping(t_uint256,t_mapping(t_bytes32,t_bool))": { - "label": "mapping(uint256 => mapping(bytes32 => bool))", - "numberOfBytes": "32" - }, - "t_mapping(t_uint256,t_string_storage)": { - "label": "mapping(uint256 => string)", - "numberOfBytes": "32" - }, - "t_mapping(t_uint256,t_uint256)": { - "label": "mapping(uint256 => uint256)", - "numberOfBytes": "32" - }, - "t_string_storage": { - "label": "string", - "numberOfBytes": "32" - }, - "t_uint256": { - "label": "uint256", - "numberOfBytes": "32" - }, - "t_uint8": { - "label": "uint8", - "numberOfBytes": "1" - } - } - } - }, -<<<<<<<< HEAD:contracts/.openzeppelin/optimism.json - "030e0101c01e933929a2efcd3396e960802166732a863419a7ab502c6da71509": { - "address": "0xc695a9f30131C3566f5E7A577Cf39Ad7F305eD55", - "txHash": "0x11b92b34289c6926fd9673c234cb75c9cea9ee1b1c8462ab60745f0061c19ef5", + "125db54394ee349f18c5e7b6f717dff5868c4ccab68a96eeef38a6321b3f05b2": { + "address": "0x396D5f1EF3aa92dDAd4DEad04388374A03BC5577", "layout": { "solcVersion": "0.8.17", -======== - "ba3b8c36d1292bdec3593f0e2b8f6d2e38d080b76cb70de7876aba5db39b7d86": { - "address": "0xDb77A1fDC905685B4052a512522D502638DdA5E3", - "txHash": "0xeb77995d2103baee6ba64beff908b9ed6653f1b1c9c1373321b8e8770a89a651", - "layout": { - "solcVersion": "0.8.16", ->>>>>>>> develop:contracts/.openzeppelin/sepolia.json "storage": [ { "label": "_initialized", @@ -885,11 +147,7 @@ "slot": "401", "type": "t_uint256", "contract": "SemiFungible1155", -<<<<<<<< HEAD:contracts/.openzeppelin/optimism.json "src": "src/protocol/SemiFungible1155.sol:27" -======== - "src": "src/SemiFungible1155.sol:27" ->>>>>>>> develop:contracts/.openzeppelin/sepolia.json }, { "label": "owners", @@ -897,11 +155,7 @@ "slot": "402", "type": "t_mapping(t_uint256,t_address)", "contract": "SemiFungible1155", -<<<<<<<< HEAD:contracts/.openzeppelin/optimism.json "src": "src/protocol/SemiFungible1155.sol:38" -======== - "src": "src/SemiFungible1155.sol:38" ->>>>>>>> develop:contracts/.openzeppelin/sepolia.json }, { "label": "creators", @@ -909,11 +163,7 @@ "slot": "403", "type": "t_mapping(t_uint256,t_address)", "contract": "SemiFungible1155", -<<<<<<<< HEAD:contracts/.openzeppelin/optimism.json "src": "src/protocol/SemiFungible1155.sol:41" -======== - "src": "src/SemiFungible1155.sol:41" ->>>>>>>> develop:contracts/.openzeppelin/sepolia.json }, { "label": "tokenValues", @@ -921,11 +171,7 @@ "slot": "404", "type": "t_mapping(t_uint256,t_uint256)", "contract": "SemiFungible1155", -<<<<<<<< HEAD:contracts/.openzeppelin/optimism.json "src": "src/protocol/SemiFungible1155.sol:44" -======== - "src": "src/SemiFungible1155.sol:44" ->>>>>>>> develop:contracts/.openzeppelin/sepolia.json }, { "label": "maxIndex", @@ -933,11 +179,7 @@ "slot": "405", "type": "t_mapping(t_uint256,t_uint256)", "contract": "SemiFungible1155", -<<<<<<<< HEAD:contracts/.openzeppelin/optimism.json "src": "src/protocol/SemiFungible1155.sol:47" -======== - "src": "src/SemiFungible1155.sol:47" ->>>>>>>> develop:contracts/.openzeppelin/sepolia.json }, { "label": "__gap", @@ -945,11 +187,7 @@ "slot": "406", "type": "t_array(t_uint256)25_storage", "contract": "SemiFungible1155", -<<<<<<<< HEAD:contracts/.openzeppelin/optimism.json - "src": "src/protocol/SemiFungible1155.sol:640" -======== - "src": "src/SemiFungible1155.sol:436" ->>>>>>>> develop:contracts/.openzeppelin/sepolia.json + "src": "src/protocol/SemiFungible1155.sol:648" }, { "label": "merkleRoots", @@ -957,11 +195,7 @@ "slot": "431", "type": "t_mapping(t_uint256,t_bytes32)", "contract": "AllowlistMinter", -<<<<<<<< HEAD:contracts/.openzeppelin/optimism.json "src": "src/protocol/AllowlistMinter.sol:17" -======== - "src": "src/AllowlistMinter.sol:17" ->>>>>>>> develop:contracts/.openzeppelin/sepolia.json }, { "label": "hasBeenClaimed", @@ -969,11 +203,7 @@ "slot": "432", "type": "t_mapping(t_uint256,t_mapping(t_bytes32,t_bool))", "contract": "AllowlistMinter", -<<<<<<<< HEAD:contracts/.openzeppelin/optimism.json "src": "src/protocol/AllowlistMinter.sol:18" -======== - "src": "src/AllowlistMinter.sol:18" ->>>>>>>> develop:contracts/.openzeppelin/sepolia.json }, { "label": "maxUnits", @@ -981,11 +211,7 @@ "slot": "433", "type": "t_mapping(t_uint256,t_uint256)", "contract": "AllowlistMinter", -<<<<<<<< HEAD:contracts/.openzeppelin/optimism.json "src": "src/protocol/AllowlistMinter.sol:19" -======== - "src": "src/AllowlistMinter.sol:19" ->>>>>>>> develop:contracts/.openzeppelin/sepolia.json }, { "label": "minted", @@ -993,11 +219,7 @@ "slot": "434", "type": "t_mapping(t_uint256,t_uint256)", "contract": "AllowlistMinter", -<<<<<<<< HEAD:contracts/.openzeppelin/optimism.json "src": "src/protocol/AllowlistMinter.sol:20" -======== - "src": "src/AllowlistMinter.sol:20" ->>>>>>>> develop:contracts/.openzeppelin/sepolia.json }, { "label": "__gap", @@ -1005,11 +227,7 @@ "slot": "435", "type": "t_array(t_uint256)26_storage", "contract": "AllowlistMinter", -<<<<<<<< HEAD:contracts/.openzeppelin/optimism.json "src": "src/protocol/AllowlistMinter.sol:75" -======== - "src": "src/AllowlistMinter.sol:69" ->>>>>>>> develop:contracts/.openzeppelin/sepolia.json }, { "label": "_paused", @@ -1031,15 +249,9 @@ "label": "typeRestrictions", "offset": 0, "slot": "511", -<<<<<<<< HEAD:contracts/.openzeppelin/optimism.json - "type": "t_mapping(t_uint256,t_enum(TransferRestrictions)18919)", + "type": "t_mapping(t_uint256,t_enum(TransferRestrictions)19595)", "contract": "HypercertMinter", "src": "src/protocol/HypercertMinter.sol:20" -======== - "type": "t_mapping(t_uint256,t_enum(TransferRestrictions)6793)", - "contract": "HypercertMinter", - "src": "src/HypercertMinter.sol:20" ->>>>>>>> develop:contracts/.openzeppelin/sepolia.json }, { "label": "__gap", @@ -1047,11 +259,7 @@ "slot": "512", "type": "t_array(t_uint256)29_storage", "contract": "HypercertMinter", -<<<<<<<< HEAD:contracts/.openzeppelin/optimism.json "src": "src/protocol/HypercertMinter.sol:258" -======== - "src": "src/HypercertMinter.sol:228" ->>>>>>>> develop:contracts/.openzeppelin/sepolia.json } ], "types": { @@ -1095,11 +303,7 @@ "label": "bytes32", "numberOfBytes": "32" }, -<<<<<<<< HEAD:contracts/.openzeppelin/optimism.json - "t_enum(TransferRestrictions)18919": { -======== - "t_enum(TransferRestrictions)6793": { ->>>>>>>> develop:contracts/.openzeppelin/sepolia.json + "t_enum(TransferRestrictions)19595": { "label": "enum IHypercertToken.TransferRestrictions", "members": [ "AllowAll", @@ -1132,11 +336,7 @@ "label": "mapping(uint256 => bytes32)", "numberOfBytes": "32" }, -<<<<<<<< HEAD:contracts/.openzeppelin/optimism.json - "t_mapping(t_uint256,t_enum(TransferRestrictions)18919)": { -======== - "t_mapping(t_uint256,t_enum(TransferRestrictions)6793)": { ->>>>>>>> develop:contracts/.openzeppelin/sepolia.json + "t_mapping(t_uint256,t_enum(TransferRestrictions)19595)": { "label": "mapping(uint256 => enum IHypercertToken.TransferRestrictions)", "numberOfBytes": "32" }, @@ -1170,7 +370,11 @@ } }, "namespaces": {} - } + }, + "allAddresses": [ + "0x396D5f1EF3aa92dDAd4DEad04388374A03BC5577", + "0xEbA30978164Cc0985091F11532C8f83a5Fa98622" + ] } } } diff --git a/contracts/.openzeppelin/unknown-421614.json b/contracts/.openzeppelin/unknown-421614.json new file mode 100644 index 00000000..96d8a6f2 --- /dev/null +++ b/contracts/.openzeppelin/unknown-421614.json @@ -0,0 +1,378 @@ +{ + "manifestVersion": "3.2", + "proxies": [ + { + "address": "0x0A00a2f09cd37B24E7429c5238323bfebCfF3Ed9", + "txHash": "0xc6346fed4b5d47105450a833d50d6a195d24895fb58325313bebc27b0dbfdbd5", + "kind": "uups" + } + ], + "impls": { + "125db54394ee349f18c5e7b6f717dff5868c4ccab68a96eeef38a6321b3f05b2": { + "address": "0x689587461AA3103D3D7975c5e4B352Ab711C14C2", + "txHash": "0x631c2b653b540d3ab9aad9d6a61afab7b704d8e7862949f73d049762724a84a4", + "layout": { + "solcVersion": "0.8.17", + "storage": [ + { + "label": "_initialized", + "offset": 0, + "slot": "0", + "type": "t_uint8", + "contract": "Initializable", + "src": "lib/openzeppelin-contracts-upgradeable/contracts/proxy/utils/Initializable.sol:62", + "retypedFrom": "bool" + }, + { + "label": "_initializing", + "offset": 1, + "slot": "0", + "type": "t_bool", + "contract": "Initializable", + "src": "lib/openzeppelin-contracts-upgradeable/contracts/proxy/utils/Initializable.sol:67" + }, + { + "label": "__gap", + "offset": 0, + "slot": "1", + "type": "t_array(t_uint256)50_storage", + "contract": "ContextUpgradeable", + "src": "lib/openzeppelin-contracts-upgradeable/contracts/utils/ContextUpgradeable.sol:36" + }, + { + "label": "__gap", + "offset": 0, + "slot": "51", + "type": "t_array(t_uint256)50_storage", + "contract": "ERC165Upgradeable", + "src": "lib/openzeppelin-contracts-upgradeable/contracts/utils/introspection/ERC165Upgradeable.sol:41" + }, + { + "label": "_balances", + "offset": 0, + "slot": "101", + "type": "t_mapping(t_uint256,t_mapping(t_address,t_uint256))", + "contract": "ERC1155Upgradeable", + "src": "lib/openzeppelin-contracts-upgradeable/contracts/token/ERC1155/ERC1155Upgradeable.sol:25" + }, + { + "label": "_operatorApprovals", + "offset": 0, + "slot": "102", + "type": "t_mapping(t_address,t_mapping(t_address,t_bool))", + "contract": "ERC1155Upgradeable", + "src": "lib/openzeppelin-contracts-upgradeable/contracts/token/ERC1155/ERC1155Upgradeable.sol:28" + }, + { + "label": "_uri", + "offset": 0, + "slot": "103", + "type": "t_string_storage", + "contract": "ERC1155Upgradeable", + "src": "lib/openzeppelin-contracts-upgradeable/contracts/token/ERC1155/ERC1155Upgradeable.sol:31" + }, + { + "label": "__gap", + "offset": 0, + "slot": "104", + "type": "t_array(t_uint256)47_storage", + "contract": "ERC1155Upgradeable", + "src": "lib/openzeppelin-contracts-upgradeable/contracts/token/ERC1155/ERC1155Upgradeable.sol:528" + }, + { + "label": "__gap", + "offset": 0, + "slot": "151", + "type": "t_array(t_uint256)50_storage", + "contract": "ERC1155BurnableUpgradeable", + "src": "lib/openzeppelin-contracts-upgradeable/contracts/token/ERC1155/extensions/ERC1155BurnableUpgradeable.sol:52" + }, + { + "label": "_baseURI", + "offset": 0, + "slot": "201", + "type": "t_string_storage", + "contract": "ERC1155URIStorageUpgradeable", + "src": "lib/openzeppelin-contracts-upgradeable/contracts/token/ERC1155/extensions/ERC1155URIStorageUpgradeable.sol:27" + }, + { + "label": "_tokenURIs", + "offset": 0, + "slot": "202", + "type": "t_mapping(t_uint256,t_string_storage)", + "contract": "ERC1155URIStorageUpgradeable", + "src": "lib/openzeppelin-contracts-upgradeable/contracts/token/ERC1155/extensions/ERC1155URIStorageUpgradeable.sol:30" + }, + { + "label": "__gap", + "offset": 0, + "slot": "203", + "type": "t_array(t_uint256)48_storage", + "contract": "ERC1155URIStorageUpgradeable", + "src": "lib/openzeppelin-contracts-upgradeable/contracts/token/ERC1155/extensions/ERC1155URIStorageUpgradeable.sol:77" + }, + { + "label": "_owner", + "offset": 0, + "slot": "251", + "type": "t_address", + "contract": "OwnableUpgradeable", + "src": "lib/openzeppelin-contracts-upgradeable/contracts/access/OwnableUpgradeable.sol:22" + }, + { + "label": "__gap", + "offset": 0, + "slot": "252", + "type": "t_array(t_uint256)49_storage", + "contract": "OwnableUpgradeable", + "src": "lib/openzeppelin-contracts-upgradeable/contracts/access/OwnableUpgradeable.sol:94" + }, + { + "label": "__gap", + "offset": 0, + "slot": "301", + "type": "t_array(t_uint256)50_storage", + "contract": "ERC1967UpgradeUpgradeable", + "src": "lib/openzeppelin-contracts-upgradeable/contracts/proxy/ERC1967/ERC1967UpgradeUpgradeable.sol:211" + }, + { + "label": "__gap", + "offset": 0, + "slot": "351", + "type": "t_array(t_uint256)50_storage", + "contract": "UUPSUpgradeable", + "src": "lib/openzeppelin-contracts-upgradeable/contracts/proxy/utils/UUPSUpgradeable.sol:107" + }, + { + "label": "typeCounter", + "offset": 0, + "slot": "401", + "type": "t_uint256", + "contract": "SemiFungible1155", + "src": "src/protocol/SemiFungible1155.sol:27" + }, + { + "label": "owners", + "offset": 0, + "slot": "402", + "type": "t_mapping(t_uint256,t_address)", + "contract": "SemiFungible1155", + "src": "src/protocol/SemiFungible1155.sol:38" + }, + { + "label": "creators", + "offset": 0, + "slot": "403", + "type": "t_mapping(t_uint256,t_address)", + "contract": "SemiFungible1155", + "src": "src/protocol/SemiFungible1155.sol:41" + }, + { + "label": "tokenValues", + "offset": 0, + "slot": "404", + "type": "t_mapping(t_uint256,t_uint256)", + "contract": "SemiFungible1155", + "src": "src/protocol/SemiFungible1155.sol:44" + }, + { + "label": "maxIndex", + "offset": 0, + "slot": "405", + "type": "t_mapping(t_uint256,t_uint256)", + "contract": "SemiFungible1155", + "src": "src/protocol/SemiFungible1155.sol:47" + }, + { + "label": "__gap", + "offset": 0, + "slot": "406", + "type": "t_array(t_uint256)25_storage", + "contract": "SemiFungible1155", + "src": "src/protocol/SemiFungible1155.sol:648" + }, + { + "label": "merkleRoots", + "offset": 0, + "slot": "431", + "type": "t_mapping(t_uint256,t_bytes32)", + "contract": "AllowlistMinter", + "src": "src/protocol/AllowlistMinter.sol:17" + }, + { + "label": "hasBeenClaimed", + "offset": 0, + "slot": "432", + "type": "t_mapping(t_uint256,t_mapping(t_bytes32,t_bool))", + "contract": "AllowlistMinter", + "src": "src/protocol/AllowlistMinter.sol:18" + }, + { + "label": "maxUnits", + "offset": 0, + "slot": "433", + "type": "t_mapping(t_uint256,t_uint256)", + "contract": "AllowlistMinter", + "src": "src/protocol/AllowlistMinter.sol:19" + }, + { + "label": "minted", + "offset": 0, + "slot": "434", + "type": "t_mapping(t_uint256,t_uint256)", + "contract": "AllowlistMinter", + "src": "src/protocol/AllowlistMinter.sol:20" + }, + { + "label": "__gap", + "offset": 0, + "slot": "435", + "type": "t_array(t_uint256)26_storage", + "contract": "AllowlistMinter", + "src": "src/protocol/AllowlistMinter.sol:75" + }, + { + "label": "_paused", + "offset": 0, + "slot": "461", + "type": "t_bool", + "contract": "PausableUpgradeable", + "src": "lib/openzeppelin-contracts-upgradeable/contracts/security/PausableUpgradeable.sol:29" + }, + { + "label": "__gap", + "offset": 0, + "slot": "462", + "type": "t_array(t_uint256)49_storage", + "contract": "PausableUpgradeable", + "src": "lib/openzeppelin-contracts-upgradeable/contracts/security/PausableUpgradeable.sol:116" + }, + { + "label": "typeRestrictions", + "offset": 0, + "slot": "511", + "type": "t_mapping(t_uint256,t_enum(TransferRestrictions)19595)", + "contract": "HypercertMinter", + "src": "src/protocol/HypercertMinter.sol:20" + }, + { + "label": "__gap", + "offset": 0, + "slot": "512", + "type": "t_array(t_uint256)29_storage", + "contract": "HypercertMinter", + "src": "src/protocol/HypercertMinter.sol:258" + } + ], + "types": { + "t_address": { + "label": "address", + "numberOfBytes": "20" + }, + "t_array(t_uint256)25_storage": { + "label": "uint256[25]", + "numberOfBytes": "800" + }, + "t_array(t_uint256)26_storage": { + "label": "uint256[26]", + "numberOfBytes": "832" + }, + "t_array(t_uint256)29_storage": { + "label": "uint256[29]", + "numberOfBytes": "928" + }, + "t_array(t_uint256)47_storage": { + "label": "uint256[47]", + "numberOfBytes": "1504" + }, + "t_array(t_uint256)48_storage": { + "label": "uint256[48]", + "numberOfBytes": "1536" + }, + "t_array(t_uint256)49_storage": { + "label": "uint256[49]", + "numberOfBytes": "1568" + }, + "t_array(t_uint256)50_storage": { + "label": "uint256[50]", + "numberOfBytes": "1600" + }, + "t_bool": { + "label": "bool", + "numberOfBytes": "1" + }, + "t_bytes32": { + "label": "bytes32", + "numberOfBytes": "32" + }, + "t_enum(TransferRestrictions)19595": { + "label": "enum IHypercertToken.TransferRestrictions", + "members": [ + "AllowAll", + "DisallowAll", + "FromCreatorOnly" + ], + "numberOfBytes": "1" + }, + "t_mapping(t_address,t_bool)": { + "label": "mapping(address => bool)", + "numberOfBytes": "32" + }, + "t_mapping(t_address,t_mapping(t_address,t_bool))": { + "label": "mapping(address => mapping(address => bool))", + "numberOfBytes": "32" + }, + "t_mapping(t_address,t_uint256)": { + "label": "mapping(address => uint256)", + "numberOfBytes": "32" + }, + "t_mapping(t_bytes32,t_bool)": { + "label": "mapping(bytes32 => bool)", + "numberOfBytes": "32" + }, + "t_mapping(t_uint256,t_address)": { + "label": "mapping(uint256 => address)", + "numberOfBytes": "32" + }, + "t_mapping(t_uint256,t_bytes32)": { + "label": "mapping(uint256 => bytes32)", + "numberOfBytes": "32" + }, + "t_mapping(t_uint256,t_enum(TransferRestrictions)19595)": { + "label": "mapping(uint256 => enum IHypercertToken.TransferRestrictions)", + "numberOfBytes": "32" + }, + "t_mapping(t_uint256,t_mapping(t_address,t_uint256))": { + "label": "mapping(uint256 => mapping(address => uint256))", + "numberOfBytes": "32" + }, + "t_mapping(t_uint256,t_mapping(t_bytes32,t_bool))": { + "label": "mapping(uint256 => mapping(bytes32 => bool))", + "numberOfBytes": "32" + }, + "t_mapping(t_uint256,t_string_storage)": { + "label": "mapping(uint256 => string)", + "numberOfBytes": "32" + }, + "t_mapping(t_uint256,t_uint256)": { + "label": "mapping(uint256 => uint256)", + "numberOfBytes": "32" + }, + "t_string_storage": { + "label": "string", + "numberOfBytes": "32" + }, + "t_uint256": { + "label": "uint256", + "numberOfBytes": "32" + }, + "t_uint8": { + "label": "uint8", + "numberOfBytes": "1" + } + }, + "namespaces": {} + } + } + } +} diff --git a/contracts/README.md b/contracts/README.md index fc293242..7e75ebb8 100644 --- a/contracts/README.md +++ b/contracts/README.md @@ -88,7 +88,7 @@ yarn hardhat deploy --network goerli To transfer ownership of the proxy contract for upgrades, run the following: ```sh -yarn hardhat transfer-owner-minter --network goerli --proxy PROXY_CONTRACT_ADDRESS --owner NEW_OWNER_ADDRESS +yarn hardhat transfer-owner-minter --network base-sepolia --proxy PROXY_CONTRACT_ADDRESS --owner NEW_OWNER_ADDRESS ``` This is typically done to transfer control to a multi-sig (i.e. Gnosis Safe). diff --git a/contracts/RELEASE.md b/contracts/RELEASE.md index e8b1a9ac..ce72ed0f 100644 --- a/contracts/RELEASE.md +++ b/contracts/RELEASE.md @@ -1,3 +1,8 @@ +# 2.0.0 + +- Marketplace contracts +- Arbitrum testnet + # 1.1.2 - Add Base and Base Sepolia to types diff --git a/contracts/contracts/AllowlistMinter.sol b/contracts/contracts/AllowlistMinter.sol deleted file mode 100644 index 599831cb..00000000 --- a/contracts/contracts/AllowlistMinter.sol +++ /dev/null @@ -1,70 +0,0 @@ -// SPDX-License-Identifier: MIT -pragma solidity 0.8.16; - -import {MerkleProofUpgradeable} from "oz-upgradeable/utils/cryptography/MerkleProofUpgradeable.sol"; -import {IAllowlist} from "./interfaces/IAllowlist.sol"; - -import {Errors} from "./libs/Errors.sol"; - -/// @title Interface for hypercert token interactions -/// @author bitbeckers -/// @notice This interface declares the required functionality for a hypercert token -/// @notice This interface does not specify the underlying token type (e.g. 721 or 1155) -contract AllowlistMinter is IAllowlist { - event AllowlistCreated(uint256 tokenID, bytes32 root); - event LeafClaimed(uint256 tokenID, bytes32 leaf); - - mapping(uint256 => bytes32) internal merkleRoots; - mapping(uint256 => mapping(bytes32 => bool)) public hasBeenClaimed; - mapping(uint256 => uint256) internal maxUnits; - mapping(uint256 => uint256) internal minted; - - function isAllowedToClaim(bytes32[] calldata proof, uint256 claimID, bytes32 leaf) - external - view - returns (bool isAllowed) - { - if (merkleRoots[claimID].length == 0) revert Errors.DoesNotExist(); - isAllowed = MerkleProofUpgradeable.verifyCalldata(proof, merkleRoots[claimID], leaf); - } - - function _createAllowlist(uint256 claimID, bytes32 merkleRoot, uint256 units) internal { - if (merkleRoot == "" || units == 0) revert Errors.Invalid(); - if (merkleRoots[claimID] != "") revert Errors.DuplicateEntry(); - - merkleRoots[claimID] = merkleRoot; - maxUnits[claimID] = units; - emit AllowlistCreated(claimID, merkleRoot); - } - - function _processClaim(bytes32[] calldata proof, uint256 claimID, uint256 amount) internal { - if (merkleRoots[claimID].length == 0) revert Errors.DoesNotExist(); - - bytes32 leaf = _calculateLeaf(msg.sender, amount); - - if (hasBeenClaimed[claimID][leaf]) revert Errors.AlreadyClaimed(); - if ( - !MerkleProofUpgradeable.verifyCalldata(proof, merkleRoots[claimID], leaf) - || (minted[claimID] + amount) > maxUnits[claimID] - ) revert Errors.Invalid(); - hasBeenClaimed[claimID][leaf] = true; - - emit LeafClaimed(claimID, leaf); - } - - function _calculateLeaf(address account, uint256 amount) internal pure returns (bytes32 leaf) { - leaf = keccak256(bytes.concat(keccak256(abi.encode(account, amount)))); - } - - /** - * @dev This empty reserved space is put in place to allow future versions to add new - * variables without shifting down storage in the inheritance chain. - * See https://docs.openzeppelin.com/contracts/4.x/upgradeable#storage_gaps - * Assuming 30 available slots (slots cost space, cost gas) - * 1. merkleRoots - * 2. hasBeenClaimed - * 3. maxUnits - * 4. minted - */ - uint256[26] private __gap; -} diff --git a/contracts/contracts/HypercertMinter.sol b/contracts/contracts/HypercertMinter.sol deleted file mode 100644 index 6e97b17f..00000000 --- a/contracts/contracts/HypercertMinter.sol +++ /dev/null @@ -1,227 +0,0 @@ -// SPDX-License-Identifier: MIT -pragma solidity 0.8.16; - -import {IHypercertToken} from "./interfaces/IHypercertToken.sol"; -import {SemiFungible1155} from "./SemiFungible1155.sol"; -import {AllowlistMinter} from "./AllowlistMinter.sol"; -import {PausableUpgradeable} from "oz-upgradeable/security/PausableUpgradeable.sol"; - -import {Errors} from "./libs/Errors.sol"; - -/// @title Contract for managing hypercert claims and whitelists -/// @author bitbeckers -/// @notice Implementation of the HypercertTokenInterface using { SemiFungible1155 } as underlying token. -/// @notice This contract supports whitelisted minting via { AllowlistMinter }. -/// @dev Wrapper contract to expose and chain functions. -contract HypercertMinter is IHypercertToken, SemiFungible1155, AllowlistMinter, PausableUpgradeable { - // solhint-disable-next-line const-name-snakecase - string public constant name = "HypercertMinter"; - /// @dev from typeID to a transfer policy - mapping(uint256 => TransferRestrictions) internal typeRestrictions; - - /// INIT - - /// @dev see { openzeppelin-contracts-upgradeable/contracts/proxy/utils/Initializable.sol } - /// @custom:oz-upgrades-unsafe-allow constructor - constructor() { - _disableInitializers(); - } - - /// @dev see { openzeppelin-contracts-upgradeable/contracts/proxy/utils/Initializable.sol } - function initialize() public virtual initializer { - __SemiFungible1155_init(); - __Pausable_init(); - } - - /// EXTERNAL - - /// @notice Mint a semi-fungible token for the impact claim referenced via `uri` - /// @dev see {IHypercertToken} - function mintClaim(address account, uint256 units, string memory _uri, TransferRestrictions restrictions) - external - override - whenNotPaused - { - // This enables us to release this restriction in the future - if (msg.sender != account) revert Errors.NotAllowed(); - uint256 claimID = _mintNewTypeWithToken(account, units, _uri); - typeRestrictions[claimID] = restrictions; - emit ClaimStored(claimID, _uri, units); - } - - /// @notice Mint semi-fungible tokens for the impact claim referenced via `uri` - /// @dev see {IHypercertToken} - function mintClaimWithFractions( - address account, - uint256 units, - uint256[] calldata fractions, - string memory _uri, - TransferRestrictions restrictions - ) external override whenNotPaused { - // This enables us to release this restriction in the future - if (msg.sender != account) revert Errors.NotAllowed(); - //Using sum to compare units and fractions (sanity check) - if (_getSum(fractions) != units) revert Errors.Invalid(); - - uint256 claimID = _mintNewTypeWithTokens(account, fractions, _uri); - typeRestrictions[claimID] = restrictions; - emit ClaimStored(claimID, _uri, units); - } - - /// @notice Mint a semi-fungible token representing a fraction of the claim - /// @dev Calls AllowlistMinter to verify `proof`. - /// @dev Mints the `amount` of units for the hypercert stored under `claimID` - function mintClaimFromAllowlist(address account, bytes32[] calldata proof, uint256 claimID, uint256 units) - external - whenNotPaused - { - _processClaim(proof, claimID, units); - _mintToken(account, claimID, units); - } - - /// @notice Mint semi-fungible tokens representing a fraction of the claims in `claimIDs` - /// @dev Calls AllowlistMinter to verify `proofs`. - /// @dev Mints the `amount` of units for the hypercert stored under `claimIDs` - function batchMintClaimsFromAllowlists( - address account, - bytes32[][] calldata proofs, - uint256[] calldata claimIDs, - uint256[] calldata units - ) external whenNotPaused { - uint256 len = claimIDs.length; - for (uint256 i; i < len;) { - _processClaim(proofs[i], claimIDs[i], units[i]); - unchecked { - ++i; - } - } - _batchMintTokens(account, claimIDs, units); - } - - /// @notice Register a claim and the whitelist for minting token(s) belonging to that claim - /// @dev Calls SemiFungible1155 to store the claim referenced in `uri` with amount of `units` - /// @dev Calls AllowlistMinter to store the `merkleRoot` as proof to authorize claims - function createAllowlist( - address account, - uint256 units, - bytes32 merkleRoot, - string memory _uri, - TransferRestrictions restrictions - ) external whenNotPaused { - uint256 claimID = _createTokenType(account, units, _uri); - _createAllowlist(claimID, merkleRoot, units); - typeRestrictions[claimID] = restrictions; - emit ClaimStored(claimID, _uri, units); - } - - /// @notice Split a claimtokens value into parts with summed value equal to the original - /// @dev see {IHypercertToken} - function splitFraction(address _to, uint256 _tokenID, uint256[] calldata _newFractions) external whenNotPaused { - _splitTokenUnits(_to, _tokenID, _newFractions); - } - - /// @notice Merge the value of tokens belonging to the same claim - /// @dev see {IHypercertToken} - function mergeFractions(address _account, uint256[] calldata _fractionIDs) external whenNotPaused { - _mergeTokensUnits(_account, _fractionIDs); - } - - /// @notice Burn a claimtoken - /// @dev see {IHypercertToken} - function burnFraction(address _account, uint256 _tokenID) external whenNotPaused { - _burnToken(_account, _tokenID); - } - - /// @dev see {IHypercertToken} - function unitsOf(uint256 tokenID) external view override returns (uint256 units) { - units = _unitsOf(tokenID); - } - - /// @dev see {IHypercertToken} - function unitsOf(address account, uint256 tokenID) external view override returns (uint256 units) { - units = _unitsOf(account, tokenID); - } - - /// PAUSABLE - - function pause() external onlyOwner { - _pause(); - } - - function unpause() external onlyOwner { - _unpause(); - } - - /// METADATA - - /// @dev see { IHypercertMetadata} - function uri(uint256 tokenID) - public - view - override(IHypercertToken, SemiFungible1155) - returns (string memory _uri) - { - _uri = SemiFungible1155.uri(tokenID); - } - - /// TRANSFER RESTRICTIONS - - function readTransferRestriction(uint256 tokenID) external view returns (string memory) { - TransferRestrictions temp = typeRestrictions[getBaseType(tokenID)]; - if (temp == TransferRestrictions.AllowAll) return "AllowAll"; - if (temp == TransferRestrictions.DisallowAll) return "DisallowAll"; - if (temp == TransferRestrictions.FromCreatorOnly) return "FromCreatorOnly"; - return ""; - } - - /// INTERNAL - - /// @dev see { openzeppelin-contracts-upgradeable/contracts/proxy/utils/UUPSUpgradeable.sol } - function _authorizeUpgrade(address newImplementation) internal virtual override onlyOwner { - // solhint-disable-previous-line no-empty-blocks - } - - function _beforeTokenTransfer( - address operator, - address from, - address to, - uint256[] memory ids, - uint256[] memory amounts, - bytes memory data - ) internal virtual override { - super._beforeTokenTransfer(operator, from, to, ids, amounts, data); - - // By-pass transfer restrictions for minting and burning - if (from == address(0)) { - // Minting - return; - } else if (to == address(0)) { - // Burning - return; - } - - // Transfer case, where to and from are non-zero - uint256 len = ids.length; - for (uint256 i; i < len;) { - uint256 typeID = getBaseType(ids[i]); - TransferRestrictions policy = typeRestrictions[typeID]; - if (policy == TransferRestrictions.DisallowAll) { - revert Errors.TransfersNotAllowed(); - } else if (policy == TransferRestrictions.FromCreatorOnly && from != creators[typeID]) { - revert Errors.TransfersNotAllowed(); - } - unchecked { - ++i; - } - } - } - - /** - * @dev This empty reserved space is put in place to allow future versions to add new - * variables without shifting down storage in the inheritance chain. - * See https://docs.openzeppelin.com/contracts/4.x/upgradeable#storage_gaps - * Assuming 30 available slots (slots cost space, cost gas) - * 1. typeRestrictions - */ - uint256[29] private __gap; -} diff --git a/contracts/contracts/SemiFungible1155.sol b/contracts/contracts/SemiFungible1155.sol deleted file mode 100644 index 07a0382a..00000000 --- a/contracts/contracts/SemiFungible1155.sol +++ /dev/null @@ -1,443 +0,0 @@ -// SPDX-License-Identifier: MIT -// Used components of Enjin example implementation for mixed fungibility -// https://github.com/enjin/erc-1155/blob/master/contracts/ERC1155MixedFungibleMintable.sol -pragma solidity 0.8.16; - -import {ERC1155Upgradeable} from "oz-upgradeable/token/ERC1155/ERC1155Upgradeable.sol"; -import {ERC1155BurnableUpgradeable} from "oz-upgradeable/token/ERC1155/extensions/ERC1155BurnableUpgradeable.sol"; -import {ERC1155URIStorageUpgradeable} from "oz-upgradeable/token/ERC1155/extensions/ERC1155URIStorageUpgradeable.sol"; -import {OwnableUpgradeable} from "oz-upgradeable/access/OwnableUpgradeable.sol"; -import {Initializable} from "oz-upgradeable/proxy/utils/Initializable.sol"; -import {UUPSUpgradeable} from "oz-upgradeable/proxy/utils/UUPSUpgradeable.sol"; -import {Errors} from "./libs/Errors.sol"; - -/// @title Contract for minting semi-fungible EIP1155 tokens -/// @author bitbeckers -/// @notice Extends { Upgradeable1155 } token with semi-fungible properties and the concept of `units` -/// @dev Adds split bit strategy as described in [EIP-1155](https://eips.ethereum.org/EIPS/eip-1155#non-fungible-tokens) -contract SemiFungible1155 is - Initializable, - ERC1155Upgradeable, - ERC1155BurnableUpgradeable, - ERC1155URIStorageUpgradeable, - OwnableUpgradeable, - UUPSUpgradeable -{ - /// @dev Counter used to generate next typeID. - uint256 internal typeCounter; - - /// @dev Bitmask used to expose only upper 128 bits of uint256 - uint256 internal constant TYPE_MASK = type(uint256).max << 128; - - /// @dev Bitmask used to expose only lower 128 bits of uint256 - uint256 internal constant NF_INDEX_MASK = type(uint256).max >> 128; - - uint256 internal constant FRACTION_LIMIT = 253; - - /// @dev Mapping of `tokenID` to address of `owner` - mapping(uint256 => address) internal owners; - - /// @dev Mapping of `tokenID` to address of `creator` - mapping(uint256 => address) internal creators; - - /// @dev Used to determine amount of `units` stored in token at `tokenID` - mapping(uint256 => uint256) internal tokenValues; - - /// @dev Used to find highest index of token belonging to token at `typeID` - mapping(uint256 => uint256) internal maxIndex; - - /// @dev Emitted on transfer of `value` between `fromTokenID` to `toTokenID` of the same `claimID` - event ValueTransfer(uint256 claimID, uint256 fromTokenID, uint256 toTokenID, uint256 value); - - /// @dev Emitted on transfer of `values` between `fromTokenIDs` to `toTokenIDs` of `claimIDs` - event BatchValueTransfer(uint256[] claimIDs, uint256[] fromTokenIDs, uint256[] toTokenIDs, uint256[] values); - - /// @dev see { openzeppelin-contracts-upgradeable/contracts/proxy/utils/Initializable.sol } - // solhint-disable-next-line func-name-mixedcase - function __SemiFungible1155_init() public virtual onlyInitializing { - __ERC1155_init(""); - __ERC1155Burnable_init(); - __ERC1155URIStorage_init(); - __Ownable_init(); - __UUPSUpgradeable_init(); - } - - /// @dev Get index of fractional token at `_id` by returning lower 128 bit values - /// @dev Returns 0 if `_id` is a baseType - function getItemIndex(uint256 tokenID) internal pure returns (uint256) { - return tokenID & NF_INDEX_MASK; - } - - /// @dev Get base type ID for token at `_id` by returning upper 128 bit values - function getBaseType(uint256 tokenID) internal pure returns (uint256) { - return tokenID & TYPE_MASK; - } - - /// @dev Identify that token at `_id` is base type. - /// @dev Upper 128 bits identify base type ID, lower bits should be 0 - function isBaseType(uint256 tokenID) internal pure returns (bool) { - return (tokenID & TYPE_MASK == tokenID) && (tokenID & NF_INDEX_MASK == 0); - } - - /// @dev Identify that token at `_id` is fraction of a claim. - /// @dev Upper 128 bits identify base type ID, lower bits should be > 0 - function isTypedItem(uint256 tokenID) internal pure returns (bool) { - return (tokenID & TYPE_MASK != 0) && (tokenID & NF_INDEX_MASK != 0); - } - - /// READ - function ownerOf(uint256 tokenID) public view returns (address _owner) { - _owner = owners[tokenID]; - } - - /// @dev see {IHypercertToken} - function _unitsOf(uint256 tokenID) internal view returns (uint256 units) { - units = tokenValues[tokenID]; - } - - /// @dev see {IHypercertToken} - function _unitsOf(address account, uint256 tokenID) internal view returns (uint256 units) { - // Check if fraction token and accounts owns it - if (ownerOf(tokenID) == account) { - units = tokenValues[tokenID]; - } - } - - /// MUTATE - - /// @dev create token type ID based of token counter - - function _createTokenType(address _account, uint256 units, string memory _uri) internal returns (uint256 typeID) { - _notMaxType(typeCounter); - typeID = ++typeCounter << 128; - - creators[typeID] = _account; - tokenValues[typeID] = units; - - _setURI(typeID, _uri); - - //Event emitted for indexing purposes - emit TransferSingle(_account, address(0), address(0), typeID, 0); - } - - /// @dev Mint a new token type and the initial units - function _mintNewTypeWithToken(address _account, uint256 _units, string memory _uri) - internal - returns (uint256 typeID) - { - if (_units == 0) { - revert Errors.NotAllowed(); - } - typeID = _createTokenType(_account, _units, _uri); - - uint256 tokenID = typeID + ++maxIndex[typeID]; //1 based indexing, 0 holds type data - - tokenValues[tokenID] = _units; - - _mint(_account, tokenID, 1, ""); - emit ValueTransfer(typeID, 0, tokenID, _units); - } - - /// @dev Mint a new token type and the initial fractions - function _mintNewTypeWithTokens(address _account, uint256[] calldata _fractions, string memory _uri) - internal - returns (uint256 typeID) - { - typeID = _mintNewTypeWithToken(_account, _getSum(_fractions), _uri); - _splitTokenUnits(_account, typeID + maxIndex[typeID], _fractions); - } - - /// @dev Mint a new token for an existing type - function _mintToken(address _account, uint256 _typeID, uint256 _units) internal returns (uint256 tokenID) { - if (!isBaseType(_typeID)) revert Errors.NotAllowed(); - - _notMaxItem(maxIndex[_typeID]); - - unchecked { - tokenID = _typeID + ++maxIndex[_typeID]; //1 based indexing, 0 holds type data - } - - tokenValues[tokenID] = _units; - - _mint(_account, tokenID, 1, ""); - emit ValueTransfer(_typeID, 0, tokenID, _units); - } - - /// @dev Mint new tokens for existing types - /// @notice Enables batch claiming from multiple allowlists - function _batchMintTokens(address _account, uint256[] calldata _typeIDs, uint256[] calldata _units) - internal - returns (uint256[] memory tokenIDs) - { - uint256 len = _typeIDs.length; - - tokenIDs = new uint256[](len); - uint256[] memory amounts = new uint256[](len); - uint256[] memory zeroes = new uint256[](len); - - for (uint256 i; i < len;) { - uint256 _typeID = _typeIDs[i]; - if (!isBaseType(_typeID)) revert Errors.NotAllowed(); - _notMaxItem(maxIndex[_typeID]); - - unchecked { - uint256 tokenID = _typeID + ++maxIndex[_typeID]; //1 based indexing, 0 holds type data - tokenValues[tokenID] = _units[i]; - tokenIDs[i] = tokenID; - amounts[i] = 1; - ++i; - } - } - - _mintBatch(_account, tokenIDs, amounts, ""); - emit BatchValueTransfer(_typeIDs, zeroes, tokenIDs, _units); - } - - /// @dev Split the units of `_tokenID` across `_values` to `_to` - /// @dev `_values` must sum to total `units` held at `_tokenID` - /// @dev `_to` must not be zero address, that's a burn - function _splitTokenUnits(address _to, uint256 _tokenID, uint256[] calldata _values) internal { - if (_values.length > FRACTION_LIMIT || _values.length < 2) revert Errors.ArraySize(); - if (tokenValues[_tokenID] != _getSum(_values)) revert Errors.NotAllowed(); - if (_to == address(0)) revert Errors.NotAllowed(); - - // Current token - uint256 _typeID = getBaseType(_tokenID); - uint256 valueLeft = tokenValues[_tokenID]; - - // Prepare batch processing, we want to skip the first entry - uint256 len = _values.length - 1; - - uint256[] memory typeIDs = new uint256[](len); - uint256[] memory fromIDs = new uint256[](len); - uint256[] memory toIDs = new uint256[](len); - uint256[] memory amounts = new uint256[](len); - uint256[] memory values = new uint256[](len); - - { - uint256[] memory _valuesCache = _values; - uint256 swapValue = _valuesCache[len]; - _valuesCache[len] = _valuesCache[0]; - _valuesCache[0] = swapValue; - - for (uint256 i; i < len;) { - _notMaxItem(maxIndex[_typeID]); - - typeIDs[i] = _typeID; - fromIDs[i] = _tokenID; - toIDs[i] = _typeID + ++maxIndex[_typeID]; - amounts[i] = 1; - values[i] = _valuesCache[i]; - - unchecked { - ++i; - } - } - } - - _beforeUnitTransfer(_msgSender(), owners(_tokenID), fromIDs, toIDs, values, ""); - - for (uint256 i; i < len;) { - valueLeft -= values[i]; - - tokenValues[toIDs[i]] = values[i]; - - unchecked { - ++i; - } - } - - tokenValues[_tokenID] = valueLeft; - - _mintBatch(_to, toIDs, amounts, ""); - - emit BatchValueTransfer(typeIDs, fromIDs, toIDs, values); - } - - /// @dev Merge the units of `_fractionIDs`. - /// @dev Base type of `_fractionIDs` must be identical for all tokens. - function _mergeTokensUnits(address _account, uint256[] memory _fractionIDs) internal { - if (_fractionIDs.length > FRACTION_LIMIT || _fractionIDs.length < 2) { - revert Errors.ArraySize(); - } - - uint256 len = _fractionIDs.length - 1; - - uint256 target = _fractionIDs[len]; - - if (_to == address(0) || owners[target] != _account) revert Errors.NotAllowed(); - - uint256 _totalValue; - uint256[] memory fromIDs = new uint256[](len); - uint256[] memory toIDs = new uint256[](len); - uint256[] memory values = new uint256[](len); - uint256[] memory amounts = new uint256[](len); - - { - for (uint256 i; i < len;) { - uint256 _fractionID = _fractionIDs[i]; - fromIDs[i] = _fractionID; - toIDs[i] = target; - amounts[i] = 1; - values[i] = tokenValues[_fractionID]; - - if (owners[_fractionID] != _account) { - revert Errors.NotAllowed(); - } - - unchecked { - ++i; - } - } - } - - _beforeUnitTransfer(_msgSender(), _account, fromIDs, toIDs, values, ""); - - for (uint256 i; i < len;) { - _totalValue += values[i]; - - delete tokenValues[fromIDs[i]]; - unchecked { - ++i; - } - } - - tokenValues[target] += _totalValue; - - _burnBatch(_account, fromIDs, amounts); - } - - /// @dev Burn the token at `_tokenID` owned by `_account` - /// @dev Not allowed to burn base type. - /// @dev `_tokenID` must hold all value declared at base type - function _burnToken(address _account, uint256 _tokenID) internal { - if (_account != _msgSender() && !isApprovedForAll(_account, _msgSender())) revert Errors.NotApprovedOrOwner(); - - uint256 value = tokenValues[_tokenID]; - - delete tokenValues[_tokenID]; - - _burn(_account, _tokenID, 1); - emit ValueTransfer(getBaseType(_tokenID), _tokenID, 0, value); - } - - /// TRANSFERS - - // The following functions are overrides required by Solidity. - function _afterTokenTransfer( - address operator, - address from, - address to, - uint256[] memory ids, - uint256[] memory amounts, - bytes memory data - ) internal virtual override { - super._afterTokenTransfer(operator, from, to, ids, amounts, data); - - uint256 len = ids.length; - - for (uint256 i; i < len;) { - owners[ids[i]] = to; - unchecked { - ++i; - } - } - } - - function _beforeUnitTransfer( - address operator, - address from, - uint256[] memory fromIDs, - uint256[] memory toIDs, - uint256[] memory values, - bytes memory data - ) internal virtual { - uint256 len = fromIDs.length; - if (from != _msgSender() && !isApprovedForAll(from, _msgSender())) revert Errors.NotApprovedOrOwner(); - - for (uint256 i; i < len;) { - uint256 _from = fromIDs[i]; - uint256 _to = toIDs[i]; - - if (isBaseType(_from)) revert Errors.NotAllowed(); - if (getBaseType(_from) != getBaseType(_to)) revert Errors.TypeMismatch(); - unchecked { - ++i; - } - } - } - - /// METADATA - - /// @dev see { openzeppelin-contracts-upgradeable/token/ERC1155/extensions/ERC1155URIStorageUpgradeable.sol } - /// @dev Always returns the URI for the basetype so that it's managed in one place. - function uri(uint256 tokenID) - public - view - virtual - override(ERC1155Upgradeable, ERC1155URIStorageUpgradeable) - returns (string memory _uri) - { - // All tokens share the same metadata at the moment - _uri = ERC1155URIStorageUpgradeable.uri(getBaseType(tokenID)); - } - - /// UTILS - - /** - * @dev Check if value is below max item index - */ - function _notMaxItem(uint256 tokenID) private pure { - uint128 _count = uint128(tokenID); - ++_count; - } - - /** - * @dev Check if value is below max type index - */ - function _notMaxType(uint256 tokenID) private pure { - uint128 _count = uint128(tokenID >> 128); - ++_count; - } - - /** - * @dev calculate the sum of the elements of an array - */ - function _getSum(uint256[] memory array) internal pure returns (uint256 sum) { - uint256 len = array.length; - for (uint256 i; i < len;) { - if (array[i] == 0) revert Errors.NotAllowed(); - sum += array[i]; - unchecked { - ++i; - } - } - } - - function _getSingletonArray(uint256 element) private pure returns (uint256[] memory) { - uint256[] memory array = new uint256[](1); - array[0] = element; - - return array; - } - - // UUPS PROXY - - /// @dev see { openzeppelin-contracts-upgradeable/contracts/proxy/utils/UUPSUpgradeable.sol } - function _authorizeUpgrade(address newImplementation) internal virtual override onlyOwner { - // solhint-disable-previous-line no-empty-blocks - } - - /** - * @dev This empty reserved space is put in place to allow future versions to add new - * variables without shifting down storage in the inheritance chain. - * See https://docs.openzeppelin.com/contracts/4.x/upgradeable#storage_gaps - * Assuming 30 available slots (slots cost space, cost gas) - * 1. typeCounter - * 2. owners - * 3. creators - * 4. tokenValues - * 5. maxIndex - */ - uint256[25] private __gap; -} diff --git a/contracts/contracts/interfaces/IAllowlist.sol b/contracts/contracts/interfaces/IAllowlist.sol deleted file mode 100644 index 2ce9a044..00000000 --- a/contracts/contracts/interfaces/IAllowlist.sol +++ /dev/null @@ -1,13 +0,0 @@ -// SPDX-License-Identifier: MIT -pragma solidity 0.8.16; - -/// @title Interface for allowlist -/// @author bitbeckers -/// @notice This interface declares the required functionality for a hypercert token -/// @notice This interface does not specify the underlying token type (e.g. 721 or 1155) -interface IAllowlist { - function isAllowedToClaim(bytes32[] calldata proof, uint256 tokenID, bytes32 leaf) - external - view - returns (bool isAllowed); -} diff --git a/contracts/contracts/interfaces/IHypercertToken.sol b/contracts/contracts/interfaces/IHypercertToken.sol deleted file mode 100644 index 1ed1e34e..00000000 --- a/contracts/contracts/interfaces/IHypercertToken.sol +++ /dev/null @@ -1,62 +0,0 @@ -// SPDX-License-Identifier: MIT -pragma solidity 0.8.16; - -/// @title Interface for hypercert token interactions -/// @author bitbeckers -/// @notice This interface declares the required functionality for a hypercert token -/// @notice This interface does not specify the underlying token type (e.g. 721 or 1155) -interface IHypercertToken { - /** - * AllowAll = Unrestricted - * DisallowAll = Transfers disabled after minting - * FromCreatorOnly = Only the original creator can transfer - */ - /// @dev Transfer restriction policies on hypercerts - enum TransferRestrictions { - AllowAll, - DisallowAll, - FromCreatorOnly - } - - /// @dev Emitted when token with tokenID `claimID` is stored, with external data reference via `uri`. - event ClaimStored(uint256 indexed claimID, string uri, uint256 totalUnits); - - /// @dev Function called to store a claim referenced via `uri` with a maximum number of fractions `units`. - function mintClaim(address account, uint256 units, string memory uri, TransferRestrictions restrictions) external; - - /// @dev Function called to store a claim referenced via `uri` with a set of `fractions`. - /// @dev Fractions are internally summed to total units. - function mintClaimWithFractions( - address account, - uint256 units, - uint256[] memory fractions, - string memory uri, - TransferRestrictions restrictions - ) external; - - /// @dev Function called to split `tokenID` owned by `account` into units declared in `values`. - /// @notice The sum of `values` must equal the current value of `_tokenID`. - function splitFraction(address account, uint256 tokenID, uint256[] memory _values) external; - - /// @dev Function called to merge tokens within `tokenIDs`. - /// @notice Tokens that have been merged are burned. - function mergeFractions(address account, uint256[] memory tokenIDs) external; - - /// @dev Function to burn the token at `tokenID` for `account` - /// @notice Operator must be allowed by `creator` and the token must represent the total amount of available units. - function burnFraction(address account, uint256 tokenID) external; - - /// @dev Returns the `units` held by a (fractional) token at `claimID` - /// @dev If `tokenID` is a base type, the total amount of `units` for the claim is returned. - /// @dev If `tokenID` is a fractional token, the `units` held by the token is returned - function unitsOf(uint256 tokenID) external view returns (uint256 units); - - /// @dev Returns the `units` held by `account` of a (fractional) token at `claimID` - /// @dev If `tokenID` is a base type, the total amount of `units` held by `account` for the claim is returned. - /// @dev If `tokenID` is a fractional token, the `units` held by `account` the token is returned - function unitsOf(address account, uint256 tokenID) external view returns (uint256 units); - - /// @dev Returns the `uri` for metadata of the claim represented by `tokenID` - /// @dev Metadata must conform to { Hypercert Metadata } spec (based on ERC1155 Metadata) - function uri(uint256 tokenID) external view returns (string memory metadata); -} diff --git a/contracts/contracts/libs/Errors.sol b/contracts/contracts/libs/Errors.sol deleted file mode 100644 index e19d6b5c..00000000 --- a/contracts/contracts/libs/Errors.sol +++ /dev/null @@ -1,15 +0,0 @@ -// SPDX-License-Identifier: MIT -pragma solidity ^0.8.16; - -/// @author bitbeckers -library Errors { - error AlreadyClaimed(); - error ArraySize(); - error DoesNotExist(); - error DuplicateEntry(); - error Invalid(); - error NotAllowed(); - error NotApprovedOrOwner(); - error TransfersNotAllowed(); - error TypeMismatch(); -} diff --git a/contracts/foundry.toml b/contracts/foundry.toml index df710d19..2b0c1e76 100644 --- a/contracts/foundry.toml +++ b/contracts/foundry.toml @@ -33,12 +33,14 @@ goerli = { key = "${ETHERSCAN_API_KEY}" } optimism = { key = "${OPTIMISTIC_ETHERSCAN_API_KEY}" } sepolia = { key = "${ETHERSCAN_API_KEY}" } celo = { key = "${CELOSCAN_API_KEY}" } +arb_sepolia = { key = "${API_KEY_ARBISCAN}", url = "https://api-sepolia.arbiscan.io/api" } [rpc_endpoints] mainnet = "https://eth-pokt.nodies.app" goerli = "https://eth-goerli.g.alchemy.com/v2/${ALCHEMY_API_KEY}" optimism = "https://opt-mainnet.g.alchemy.com/v2/${ALCHEMY_API_KEY}" sepolia = "https://sepolia.infura.io/v3/${INFURA_API_KEY}" +arb_sepolia = "https://arb-sepolia.g.alchemy.com/v2/${ALCHEMY_API_KEY}" celo = "https://forno.celo.org" [fmt] diff --git a/contracts/hardhat.config.ts b/contracts/hardhat.config.cts similarity index 81% rename from contracts/hardhat.config.ts rename to contracts/hardhat.config.cts index 0c71182d..1a8789a8 100644 --- a/contracts/hardhat.config.ts +++ b/contracts/hardhat.config.cts @@ -1,9 +1,11 @@ import { HardhatUserConfig } from "hardhat/config"; -import "@nomicfoundation/hardhat-toolbox"; +// import "@nomicfoundation/hardhat-toolbox"; import "@nomicfoundation/hardhat-chai-matchers"; import "@nomicfoundation/hardhat-ethers"; import "@nomicfoundation/hardhat-viem"; import "@openzeppelin/hardhat-upgrades"; +import "@typechain/hardhat"; +import "@nomicfoundation/hardhat-ethers"; import "@primitivefi/hardhat-dodoc"; import { config as dotenvConfig } from "dotenv"; @@ -49,9 +51,7 @@ const OPTIMISTIC_ETHERSCAN_API_KEY = requireEnv( ); const CELOSCAN_API_KEY = requireEnv(process.env.CELOSCAN_API_KEY, "CELOSCAN_API_KEY"); const BASESCAN_API_KEY = requireEnv(process.env.BASESCAN_API_KEY, "BASESCAN_API_KEY"); - -const OPENZEPPELIN_API_KEY = requireEnv(process.env.OPENZEPPELIN_API_KEY, "OPENZEPPELIN_API_KEY"); -const OPENZEPPELIN_SECRET_KEY = requireEnv(process.env.OPENZEPPELIN_SECRET_KEY, "OPENZEPPELIN_SECRET_KEY"); +const ARBISCAN_API_KEY = requireEnv(process.env.ARBISCAN_API_KEY, "ARBISCAN_API_KEY"); /** * Maps a key to the chain ID @@ -59,25 +59,21 @@ const OPENZEPPELIN_SECRET_KEY = requireEnv(process.env.OPENZEPPELIN_SECRET_KEY, */ const chainIds = { hardhat: 31337, - // Ethereum: https://docs.infura.io/infura/networks/ethereum/how-to/choose-a-network sepolia: 11155111, - mainnet: 1, - // Optimism: https://docs.infura.io/infura/networks/optimism/how-to/choose-a-network "optimism-mainnet": 10, - "optimism-goerli": 420, - // Celo "celo-mainnet": 42220, - // Base "base-sepolia": 84532, "base-mainnet": 8453, + "arb-sepolia": 421614, + arbitrumOne: 42161, }; function getChainConfig(chain: keyof typeof chainIds) { const jsonRpcUrl = "https://" + chain + ".infura.io/v3/" + INFURA_API_KEY; - let config = { + let config: { [key: string]: string | number | { [key: string]: string | number } } = { accounts: { count: 10, - mnemonic: MNEMONIC, + mnemonic: MNEMONIC!, path: "m/44'/60'/0'/0", }, chainId: chainIds[chain], @@ -94,7 +90,8 @@ function getChainConfig(chain: keyof typeof chainIds) { if (chain === "base-sepolia") { config = { ...config, - url: `https://base-sepolia.g.alchemy.com/v2/${ALCHEMY_API_KEY}`, + url: `https://sepolia.base.org`, + gasPrice: 1000000000, }; } @@ -102,6 +99,22 @@ function getChainConfig(chain: keyof typeof chainIds) { config = { ...config, url: `https://base-mainnet.g.alchemy.com/v2/${ALCHEMY_API_KEY}`, + gasPrice: 1000000000, + }; + } + + if (chain === "arb-sepolia") { + config = { + ...config, + url: `https://arb-sepolia.g.alchemy.com/v2/${ALCHEMY_API_KEY}`, + }; + } + + if (chain === "arbitrumOne") { + config = { + ...config, + url: `https://arb-mainnet.g.alchemy.com/v2/${ALCHEMY_API_KEY}`, + // url: "https://virtual.arbitrum.rpc.tenderly.co/143c1212-e69c-4f74-bd24-8676c965c44c", }; } @@ -132,35 +145,29 @@ const config: HardhatUserConfig = { "OrderValidatorV2A", "StrategyManager", "TransferManager", - "StrategyCollectionOffer", - "StrategyDutchAuction", "StrategyHypercertCollectionOffer", "StrategyHypercertDutchAuction", "StrategyHypercertFractionOffer", - "StrategyItemIdsRange", "CreatorFeeManagerWithRoyalties", "RoyaltyFeeRegistry", ], except: ["@openzeppelin"], }, - defender: { - apiKey: OPENZEPPELIN_API_KEY!, - apiSecret: OPENZEPPELIN_SECRET_KEY!, - }, dodoc: { - runOnCompile: true, + runOnCompile: false, include: ["src/marketplace", "src/protocol"], freshOutput: true, outputDir: "../docs/docs/developer/api/contracts", }, etherscan: { apiKey: { - goerli: ETHERSCAN_API_KEY!, sepolia: ETHERSCAN_API_KEY!, optimisticEthereum: OPTIMISTIC_ETHERSCAN_API_KEY!, celo: CELOSCAN_API_KEY!, base: BASESCAN_API_KEY!, "base-sepolia": BASESCAN_API_KEY!, + "arb-sepolia": ARBISCAN_API_KEY!, + arbitrumOne: "DPB1JAY49URG4RJP76WQ11CMGPBF2FX3C5", }, customChains: [ { @@ -179,6 +186,14 @@ const config: HardhatUserConfig = { browserURL: "https://sepolia.basescan.org", }, }, + { + network: "arb-sepolia", + chainId: 421614, + urls: { + apiURL: "https://api-sepolia.arbiscan.io/api", + browserURL: "https://sepolia.arbiscan.io/", + }, + }, ], }, networks: { @@ -201,13 +216,12 @@ const config: HardhatUserConfig = { }, }, "celo-mainnet": getChainConfig("celo-mainnet"), - goerli: getChainConfig("goerli"), sepolia: getChainConfig("sepolia"), - mainnet: getChainConfig("mainnet"), - "optimism-goerli": getChainConfig("optimism-goerli"), "optimism-mainnet": getChainConfig("optimism-mainnet"), "base-sepolia": getChainConfig("base-sepolia"), "base-mainnet": getChainConfig("base-mainnet"), + "arb-sepolia": getChainConfig("arb-sepolia"), + arbitrumOne: getChainConfig("arbitrumOne"), }, paths: { cache: "./cache_hardhat", // Use a different cache for Hardhat than Foundry diff --git a/contracts/package.json b/contracts/package.json index a2ee9d13..9c1fec00 100644 --- a/contracts/package.json +++ b/contracts/package.json @@ -1,7 +1,7 @@ { "name": "@hypercerts-org/contracts", "description": "EVM compatible protocol for managing impact claims", - "version": "2.0.0-alpha.0", + "version": "2.0.0-alpha.9", "author": { "name": "Hypercerts Foundation", "url": "https://github.com/hypercerts-org/hypercerts" @@ -13,13 +13,13 @@ "url": "https://github.com/hypercerts-org/hypercerts", "type": "git" }, - "main": "./dist/cjs/index.js", + "main": "./dist/cjs/index.cjs", "module": "./dist/esm/index.mjs", "types": "./dist/index.d.ts", "exports": { ".": { "types": "./dist/index.d.ts", - "require": "./dist/cjs/index.js", + "require": "./dist/cjs/index.cjs", "import": "./dist/esm/index.mjs" } }, @@ -33,21 +33,21 @@ "@commitlint/cli": "^17.1.2", "@commitlint/config-conventional": "^17.1.0", "@looksrare/contracts-libs": "^3.4.0", - "@nomicfoundation/hardhat-chai-matchers": "^2.0.7", "@nomicfoundation/hardhat-ethers": "^3.0.6", "@nomicfoundation/hardhat-toolbox": "^5.0.0", "@nomicfoundation/hardhat-viem": "^2.0.2", "@openzeppelin/contracts": "^4.9.3", - "@openzeppelin/defender-sdk": "^1.13.3", - "@openzeppelin/hardhat-upgrades": "3.1.1", + "@openzeppelin/hardhat-upgrades": "3.2.1", "@primitivefi/hardhat-dodoc": "^0.2.3", "@rollup/plugin-commonjs": "^24.0.1", "@rollup/plugin-json": "^6.0.0", "@rollup/plugin-node-resolve": "^15.0.1", "@trivago/prettier-plugin-sort-imports": "^3.3.0", + "@typechain/hardhat": "^9.1.0", "@types/node": "^18.18.1", "@typescript-eslint/eslint-plugin": "^7.12.0", "@typescript-eslint/parser": "^7.12.0", + "chai": "^4.3.7", "commitizen": "^4.2.5", "cross-env": "^7.0.3", "cz-conventional-changelog": "^3.3.0", @@ -64,18 +64,18 @@ "rimraf": "^5.0.5", "rollup": "^4.0.2", "rollup-plugin-auto-external": "^2.0.0", - "rollup-plugin-copy": "^3.5.0", - "rollup-plugin-dts": "^6.1.0", + "rollup-plugin-dts": "^6.1.1", "rollup-plugin-esbuild": "^6.1.0", "rollup-plugin-node-polyfills": "^0.2.1", + "rollup-plugin-swc3": "^0.11.2", "shx": "^0.3.4", "solhint": "^3.6.2", "solhint-plugin-prettier": "^0.0.5", "solmate": "^6.2.0", "ts-node": "^10.9.1", - "typechain": "^8.3.1", - "typescript": "^4.9.4", - "viem": "^1.18.9", + "typechain": "^8.3.2", + "typescript": "^5.5.3", + "viem": "^2.19.7", "xdeployer": "^2.1.13" }, "keywords": [ @@ -92,7 +92,8 @@ "build": "pnpm clean && forge compile && hardhat compile && pnpm tsc -p tsconfig.build.json && rollup -c", "build:forge": "pnpm clean && forge build", "clean": "rimraf abi artifacts build cache cache_hardhat dist out types", - "deploy:marketplace:dryrun": "pnpm hardhat deploy-marketplace", + "deploy:marketplace:dryrun": "NODE_OPTIONS='--experimental-loader ts-node/esm/transpile-only --no-warnings=ExperimentalWarning' hardhat deploy-marketplace", + "deploy:marketplace": "NODE_OPTIONS='--experimental-loader ts-node/esm/transpile-only --no-warnings=ExperimentalWarning' hardhat deploy-marketplace", "deploy:protocol:dryrun": "pnpm hardhat deploy-minter", "deploy:protocol": "pnpm hardhat deploy-minter", "docs": "hardhat dodoc", @@ -109,6 +110,7 @@ "hardhat": "hardhat" }, "dependencies": { - "hardhat": "^2.18.3" + "@tenderly/hardhat-tenderly": "^2.3.0", + "hardhat": "^2.22.8" } } diff --git a/contracts/pnpm-lock.yaml b/contracts/pnpm-lock.yaml new file mode 100644 index 00000000..bd8e555a --- /dev/null +++ b/contracts/pnpm-lock.yaml @@ -0,0 +1,9209 @@ +lockfileVersion: '9.0' + +settings: + autoInstallPeers: true + excludeLinksFromLockfile: false + +importers: + + .: + dependencies: + '@tenderly/hardhat-tenderly': + specifier: ^2.3.0 + version: 2.3.0(@nomicfoundation/hardhat-ethers@3.0.8(ethers@6.13.2)(hardhat@2.22.10(ts-node@10.9.2(@swc/core@1.7.26)(@types/node@18.19.50)(typescript@5.6.2))(typescript@5.6.2)))(@swc/core@1.7.26)(@types/node@18.19.50)(ethers@6.13.2)(hardhat@2.22.10(ts-node@10.9.2(@swc/core@1.7.26)(@types/node@18.19.50)(typescript@5.6.2))(typescript@5.6.2)) + hardhat: + specifier: ^2.22.8 + version: 2.22.10(ts-node@10.9.2(@swc/core@1.7.26)(@types/node@18.19.50)(typescript@5.6.2))(typescript@5.6.2) + devDependencies: + '@chainlink/contracts': + specifier: ^0.8.0 + version: 0.8.0(ethers@6.13.2) + '@commitlint/cli': + specifier: ^17.1.2 + version: 17.8.1(@swc/core@1.7.26) + '@commitlint/config-conventional': + specifier: ^17.1.0 + version: 17.8.1 + '@looksrare/contracts-libs': + specifier: ^3.4.0 + version: 3.5.1 + '@nomicfoundation/hardhat-ethers': + specifier: ^3.0.6 + version: 3.0.8(ethers@6.13.2)(hardhat@2.22.10(ts-node@10.9.2(@swc/core@1.7.26)(@types/node@18.19.50)(typescript@5.6.2))(typescript@5.6.2)) + '@nomicfoundation/hardhat-toolbox': + specifier: ^5.0.0 + version: 5.0.0(@nomicfoundation/hardhat-chai-matchers@2.0.7(@nomicfoundation/hardhat-ethers@3.0.8(ethers@6.13.2)(hardhat@2.22.10(ts-node@10.9.2(@swc/core@1.7.26)(@types/node@18.19.50)(typescript@5.6.2))(typescript@5.6.2)))(chai@4.5.0)(ethers@6.13.2)(hardhat@2.22.10(ts-node@10.9.2(@swc/core@1.7.26)(@types/node@18.19.50)(typescript@5.6.2))(typescript@5.6.2)))(@nomicfoundation/hardhat-ethers@3.0.8(ethers@6.13.2)(hardhat@2.22.10(ts-node@10.9.2(@swc/core@1.7.26)(@types/node@18.19.50)(typescript@5.6.2))(typescript@5.6.2)))(@nomicfoundation/hardhat-ignition-ethers@0.15.5(@nomicfoundation/hardhat-ethers@3.0.8(ethers@6.13.2)(hardhat@2.22.10(ts-node@10.9.2(@swc/core@1.7.26)(@types/node@18.19.50)(typescript@5.6.2))(typescript@5.6.2)))(@nomicfoundation/hardhat-ignition@0.15.5(@nomicfoundation/hardhat-verify@2.0.10(hardhat@2.22.10(ts-node@10.9.2(@swc/core@1.7.26)(@types/node@18.19.50)(typescript@5.6.2))(typescript@5.6.2)))(hardhat@2.22.10(ts-node@10.9.2(@swc/core@1.7.26)(@types/node@18.19.50)(typescript@5.6.2))(typescript@5.6.2)))(@nomicfoundation/ignition-core@0.15.5)(ethers@6.13.2)(hardhat@2.22.10(ts-node@10.9.2(@swc/core@1.7.26)(@types/node@18.19.50)(typescript@5.6.2))(typescript@5.6.2)))(@nomicfoundation/hardhat-network-helpers@1.0.11(hardhat@2.22.10(ts-node@10.9.2(@swc/core@1.7.26)(@types/node@18.19.50)(typescript@5.6.2))(typescript@5.6.2)))(@nomicfoundation/hardhat-verify@2.0.10(hardhat@2.22.10(ts-node@10.9.2(@swc/core@1.7.26)(@types/node@18.19.50)(typescript@5.6.2))(typescript@5.6.2)))(@typechain/ethers-v6@0.5.1(ethers@6.13.2)(typechain@8.3.2(typescript@5.6.2))(typescript@5.6.2))(@typechain/hardhat@9.1.0(@typechain/ethers-v6@0.5.1(ethers@6.13.2)(typechain@8.3.2(typescript@5.6.2))(typescript@5.6.2))(ethers@6.13.2)(hardhat@2.22.10(ts-node@10.9.2(@swc/core@1.7.26)(@types/node@18.19.50)(typescript@5.6.2))(typescript@5.6.2))(typechain@8.3.2(typescript@5.6.2)))(@types/chai@4.3.19)(@types/mocha@10.0.7)(@types/node@18.19.50)(chai@4.5.0)(ethers@6.13.2)(hardhat-gas-reporter@1.0.10(hardhat@2.22.10(ts-node@10.9.2(@swc/core@1.7.26)(@types/node@18.19.50)(typescript@5.6.2))(typescript@5.6.2)))(hardhat@2.22.10(ts-node@10.9.2(@swc/core@1.7.26)(@types/node@18.19.50)(typescript@5.6.2))(typescript@5.6.2))(solidity-coverage@0.8.13(hardhat@2.22.10(ts-node@10.9.2(@swc/core@1.7.26)(@types/node@18.19.50)(typescript@5.6.2))(typescript@5.6.2)))(ts-node@10.9.2(@swc/core@1.7.26)(@types/node@18.19.50)(typescript@5.6.2))(typechain@8.3.2(typescript@5.6.2))(typescript@5.6.2) + '@nomicfoundation/hardhat-viem': + specifier: ^2.0.2 + version: 2.0.4(hardhat@2.22.10(ts-node@10.9.2(@swc/core@1.7.26)(@types/node@18.19.50)(typescript@5.6.2))(typescript@5.6.2))(typescript@5.6.2)(viem@2.21.5(typescript@5.6.2)) + '@openzeppelin/contracts': + specifier: ^4.9.3 + version: 4.9.6 + '@openzeppelin/hardhat-upgrades': + specifier: 3.2.1 + version: 3.2.1(@nomicfoundation/hardhat-ethers@3.0.8(ethers@6.13.2)(hardhat@2.22.10(ts-node@10.9.2(@swc/core@1.7.26)(@types/node@18.19.50)(typescript@5.6.2))(typescript@5.6.2)))(@nomicfoundation/hardhat-verify@2.0.10(hardhat@2.22.10(ts-node@10.9.2(@swc/core@1.7.26)(@types/node@18.19.50)(typescript@5.6.2))(typescript@5.6.2)))(ethers@6.13.2)(hardhat@2.22.10(ts-node@10.9.2(@swc/core@1.7.26)(@types/node@18.19.50)(typescript@5.6.2))(typescript@5.6.2)) + '@primitivefi/hardhat-dodoc': + specifier: ^0.2.3 + version: 0.2.3(hardhat@2.22.10(ts-node@10.9.2(@swc/core@1.7.26)(@types/node@18.19.50)(typescript@5.6.2))(typescript@5.6.2))(squirrelly@8.0.8) + '@rollup/plugin-commonjs': + specifier: ^24.0.1 + version: 24.1.0(rollup@4.21.2) + '@rollup/plugin-json': + specifier: ^6.0.0 + version: 6.1.0(rollup@4.21.2) + '@rollup/plugin-node-resolve': + specifier: ^15.0.1 + version: 15.2.3(rollup@4.21.2) + '@trivago/prettier-plugin-sort-imports': + specifier: ^3.3.0 + version: 3.4.0(prettier@2.8.8) + '@typechain/hardhat': + specifier: ^9.1.0 + version: 9.1.0(@typechain/ethers-v6@0.5.1(ethers@6.13.2)(typechain@8.3.2(typescript@5.6.2))(typescript@5.6.2))(ethers@6.13.2)(hardhat@2.22.10(ts-node@10.9.2(@swc/core@1.7.26)(@types/node@18.19.50)(typescript@5.6.2))(typescript@5.6.2))(typechain@8.3.2(typescript@5.6.2)) + '@types/node': + specifier: ^18.18.1 + version: 18.19.50 + '@typescript-eslint/eslint-plugin': + specifier: ^7.12.0 + version: 7.18.0(@typescript-eslint/parser@7.18.0(eslint@8.57.0)(typescript@5.6.2))(eslint@8.57.0)(typescript@5.6.2) + '@typescript-eslint/parser': + specifier: ^7.12.0 + version: 7.18.0(eslint@8.57.0)(typescript@5.6.2) + chai: + specifier: ^4.3.7 + version: 4.5.0 + commitizen: + specifier: ^4.2.5 + version: 4.3.0(@types/node@18.19.50)(typescript@5.6.2) + cross-env: + specifier: ^7.0.3 + version: 7.0.3 + cz-conventional-changelog: + specifier: ^3.3.0 + version: 3.3.0(@types/node@18.19.50)(typescript@5.6.2) + dotenv: + specifier: ^16.0.2 + version: 16.4.5 + eslint: + specifier: ^8.23.1 + version: 8.57.0 + eslint-config-prettier: + specifier: ^8.5.0 + version: 8.10.0(eslint@8.57.0) + ethers: + specifier: ^6.8.0 + version: 6.13.2 + hardhat-abi-exporter: + specifier: ^2.10.1 + version: 2.10.1(hardhat@2.22.10(ts-node@10.9.2(@swc/core@1.7.26)(@types/node@18.19.50)(typescript@5.6.2))(typescript@5.6.2)) + hardhat-preprocessor: + specifier: ^0.1.5 + version: 0.1.5(hardhat@2.22.10(ts-node@10.9.2(@swc/core@1.7.26)(@types/node@18.19.50)(typescript@5.6.2))(typescript@5.6.2)) + husky: + specifier: ^8.0.1 + version: 8.0.3 + lint-staged: + specifier: ^13.0.3 + version: 13.3.0(enquirer@2.4.1) + prettier: + specifier: ^2.8.8 + version: 2.8.8 + prettier-plugin-solidity: + specifier: ^1.1.3 + version: 1.4.1(prettier@2.8.8) + rimraf: + specifier: ^5.0.5 + version: 5.0.10 + rollup: + specifier: ^4.0.2 + version: 4.21.2 + rollup-plugin-auto-external: + specifier: ^2.0.0 + version: 2.0.0(rollup@4.21.2) + rollup-plugin-dts: + specifier: ^6.1.1 + version: 6.1.1(rollup@4.21.2)(typescript@5.6.2) + rollup-plugin-esbuild: + specifier: ^6.1.0 + version: 6.1.1(esbuild@0.23.1)(rollup@4.21.2) + rollup-plugin-node-polyfills: + specifier: ^0.2.1 + version: 0.2.1 + rollup-plugin-swc3: + specifier: ^0.11.2 + version: 0.11.2(@swc/core@1.7.26)(rollup@4.21.2) + shx: + specifier: ^0.3.4 + version: 0.3.4 + solhint: + specifier: ^3.6.2 + version: 3.6.2(typescript@5.6.2) + solhint-plugin-prettier: + specifier: ^0.0.5 + version: 0.0.5(prettier-plugin-solidity@1.4.1(prettier@2.8.8))(prettier@2.8.8) + solmate: + specifier: ^6.2.0 + version: 6.2.0 + ts-node: + specifier: ^10.9.1 + version: 10.9.2(@swc/core@1.7.26)(@types/node@18.19.50)(typescript@5.6.2) + typechain: + specifier: ^8.3.2 + version: 8.3.2(typescript@5.6.2) + typescript: + specifier: ^5.5.3 + version: 5.6.2 + viem: + specifier: ^2.19.7 + version: 2.21.5(typescript@5.6.2) + xdeployer: + specifier: ^2.1.13 + version: 2.2.2(@nomicfoundation/hardhat-ethers@3.0.8(ethers@6.13.2)(hardhat@2.22.10(ts-node@10.9.2(@swc/core@1.7.26)(@types/node@18.19.50)(typescript@5.6.2))(typescript@5.6.2)))(ethers@6.13.2)(hardhat@2.22.10(ts-node@10.9.2(@swc/core@1.7.26)(@types/node@18.19.50)(typescript@5.6.2))(typescript@5.6.2)) + +packages: + + '@adraffy/ens-normalize@1.10.0': + resolution: {integrity: sha512-nA9XHtlAkYfJxY7bce8DcN7eKxWWCWkU+1GR9d+U6MbNpfwQp8TI7vqOsBsMcHoT4mBu2kypKoSKnghEzOOq5Q==} + + '@adraffy/ens-normalize@1.10.1': + resolution: {integrity: sha512-96Z2IP3mYmF1Xg2cDm8f1gWGf/HUVedQ3FMifV4kG/PQ4yEP51xDtRAEfhVNt5f/uzpNkZHwWQuUcu6D6K+Ekw==} + + '@ampproject/remapping@2.3.0': + resolution: {integrity: sha512-30iZtAPgz+LTIYoeivqYo853f02jBYSd5uGnGpkFV0M3xOt9aN73erkgYAmZU43x4VfqcnLxW9Kpg3R5LC4YYw==} + engines: {node: '>=6.0.0'} + + '@aws-crypto/sha256-js@1.2.2': + resolution: {integrity: sha512-Nr1QJIbW/afYYGzYvrF70LtaHrIRtd4TNAglX8BvlfxJLZ45SAmueIKYl5tWoNBPzp65ymXGFK0Bb1vZUpuc9g==} + + '@aws-crypto/util@1.2.2': + resolution: {integrity: sha512-H8PjG5WJ4wz0UXAFXeJjWCW1vkvIJ3qUUD+rGRwJ2/hj+xT58Qle2MTql/2MGzkU+1JLAFuR6aJpLAjHwhmwwg==} + + '@aws-sdk/types@3.649.0': + resolution: {integrity: sha512-PuPw8RysbhJNlaD2d/PzOTf8sbf4Dsn2b7hwyGh7YVG3S75yTpxSAZxrnhKsz9fStgqFmnw/jUfV/G+uQAeTVw==} + engines: {node: '>=16.0.0'} + + '@aws-sdk/util-utf8-browser@3.259.0': + resolution: {integrity: sha512-UvFa/vR+e19XookZF8RzFZBrw2EUkQWxiBW0yYQAhvk3C+QVGl0H3ouca8LDBlBfQKXwmW3huo/59H8rwb1wJw==} + + '@babel/code-frame@7.24.7': + resolution: {integrity: sha512-BcYH1CVJBO9tvyIZ2jVeXgSIMvGZ2FDRvDdOIVQyuklNKSsx+eppDEBq/g47Ayw+RqNFE+URvOShmf+f/qwAlA==} + engines: {node: '>=6.9.0'} + + '@babel/compat-data@7.25.4': + resolution: {integrity: sha512-+LGRog6RAsCJrrrg/IO6LGmpphNe5DiK30dGjCoxxeGv49B10/3XYGxPsAwrDlMFcFEvdAUavDT8r9k/hSyQqQ==} + engines: {node: '>=6.9.0'} + + '@babel/core@7.17.8': + resolution: {integrity: sha512-OdQDV/7cRBtJHLSOBqqbYNkOcydOgnX59TZx4puf41fzcVtN3e/4yqY8lMQsK+5X2lJtAdmA+6OHqsj1hBJ4IQ==} + engines: {node: '>=6.9.0'} + + '@babel/generator@7.17.7': + resolution: {integrity: sha512-oLcVCTeIFadUoArDTwpluncplrYBmTCCZZgXCbgNGvOBBiSDDK3eWO4b/+eOTli5tKv1lg+a5/NAXg+nTcei1w==} + engines: {node: '>=6.9.0'} + + '@babel/generator@7.25.6': + resolution: {integrity: sha512-VPC82gr1seXOpkjAAKoLhP50vx4vGNlF4msF64dSFq1P8RfB+QAuJWGHPXXPc8QyfVWwwB/TNNU4+ayZmHNbZw==} + engines: {node: '>=6.9.0'} + + '@babel/helper-compilation-targets@7.25.2': + resolution: {integrity: sha512-U2U5LsSaZ7TAt3cfaymQ8WHh0pxvdHoEk6HVpaexxixjyEquMh0L0YNJNM6CTGKMXV1iksi0iZkGw4AcFkPaaw==} + engines: {node: '>=6.9.0'} + + '@babel/helper-environment-visitor@7.24.7': + resolution: {integrity: sha512-DoiN84+4Gnd0ncbBOM9AZENV4a5ZiL39HYMyZJGZ/AZEykHYdJw0wW3kdcsh9/Kn+BRXHLkkklZ51ecPKmI1CQ==} + engines: {node: '>=6.9.0'} + + '@babel/helper-function-name@7.24.7': + resolution: {integrity: sha512-FyoJTsj/PEUWu1/TYRiXTIHc8lbw+TDYkZuoE43opPS5TrI7MyONBE1oNvfguEXAD9yhQRrVBnXdXzSLQl9XnA==} + engines: {node: '>=6.9.0'} + + '@babel/helper-hoist-variables@7.24.7': + resolution: {integrity: sha512-MJJwhkoGy5c4ehfoRyrJ/owKeMl19U54h27YYftT0o2teQ3FJ3nQUf/I3LlJsX4l3qlw7WRXUmiyajvHXoTubQ==} + engines: {node: '>=6.9.0'} + + '@babel/helper-module-imports@7.24.7': + resolution: {integrity: sha512-8AyH3C+74cgCVVXow/myrynrAGv+nTVg5vKu2nZph9x7RcRwzmh0VFallJuFTZ9mx6u4eSdXZfcOzSqTUm0HCA==} + engines: {node: '>=6.9.0'} + + '@babel/helper-module-transforms@7.25.2': + resolution: {integrity: sha512-BjyRAbix6j/wv83ftcVJmBt72QtHI56C7JXZoG2xATiLpmoC7dpd8WnkikExHDVPpi/3qCmO6WY1EaXOluiecQ==} + engines: {node: '>=6.9.0'} + peerDependencies: + '@babel/core': ^7.0.0 + + '@babel/helper-simple-access@7.24.7': + resolution: {integrity: sha512-zBAIvbCMh5Ts+b86r/CjU+4XGYIs+R1j951gxI3KmmxBMhCg4oQMsv6ZXQ64XOm/cvzfU1FmoCyt6+owc5QMYg==} + engines: {node: '>=6.9.0'} + + '@babel/helper-split-export-declaration@7.24.7': + resolution: {integrity: sha512-oy5V7pD+UvfkEATUKvIjvIAH/xCzfsFVw7ygW2SI6NClZzquT+mwdTfgfdbUiceh6iQO0CHtCPsyze/MZ2YbAA==} + engines: {node: '>=6.9.0'} + + '@babel/helper-string-parser@7.24.8': + resolution: {integrity: sha512-pO9KhhRcuUyGnJWwyEgnRJTSIZHiT+vMD0kPeD+so0l7mxkMT19g3pjY9GTnHySck/hDzq+dtW/4VgnMkippsQ==} + engines: {node: '>=6.9.0'} + + '@babel/helper-validator-identifier@7.24.7': + resolution: {integrity: sha512-rR+PBcQ1SMQDDyF6X0wxtG8QyLCgUB0eRAGguqRLfkCA87l7yAP7ehq8SNj96OOGTO8OBV70KhuFYcIkHXOg0w==} + engines: {node: '>=6.9.0'} + + '@babel/helper-validator-option@7.24.8': + resolution: {integrity: sha512-xb8t9tD1MHLungh/AIoWYN+gVHaB9kwlu8gffXGSt3FFEIT7RjS+xWbc2vUD1UTZdIpKj/ab3rdqJ7ufngyi2Q==} + engines: {node: '>=6.9.0'} + + '@babel/helpers@7.25.6': + resolution: {integrity: sha512-Xg0tn4HcfTijTwfDwYlvVCl43V6h4KyVVX2aEm4qdO/PC6L2YvzLHFdmxhoeSA3eslcE6+ZVXHgWwopXYLNq4Q==} + engines: {node: '>=6.9.0'} + + '@babel/highlight@7.24.7': + resolution: {integrity: sha512-EStJpq4OuY8xYfhGVXngigBJRWxftKX9ksiGDnmlY3o7B/V7KIAc9X4oiK87uPJSc/vs5L869bem5fhZa8caZw==} + engines: {node: '>=6.9.0'} + + '@babel/parser@7.18.9': + resolution: {integrity: sha512-9uJveS9eY9DJ0t64YbIBZICtJy8a5QrDEVdiLCG97fVLpDTpGX7t8mMSb6OWw6Lrnjqj4O8zwjELX3dhoMgiBg==} + engines: {node: '>=6.0.0'} + hasBin: true + + '@babel/parser@7.25.6': + resolution: {integrity: sha512-trGdfBdbD0l1ZPmcJ83eNxB9rbEax4ALFTF7fN386TMYbeCQbyme5cOEXQhbGXKebwGaB/J52w1mrklMcbgy6Q==} + engines: {node: '>=6.0.0'} + hasBin: true + + '@babel/template@7.25.0': + resolution: {integrity: sha512-aOOgh1/5XzKvg1jvVz7AVrx2piJ2XBi227DHmbY6y+bM9H2FlN+IfecYu4Xl0cNiiVejlsCri89LUsbj8vJD9Q==} + engines: {node: '>=6.9.0'} + + '@babel/traverse@7.17.3': + resolution: {integrity: sha512-5irClVky7TxRWIRtxlh2WPUUOLhcPN06AGgaQSB8AEwuyEBgJVuJ5imdHm5zxk8w0QS5T+tDfnDxAlhWjpb7cw==} + engines: {node: '>=6.9.0'} + + '@babel/traverse@7.25.6': + resolution: {integrity: sha512-9Vrcx5ZW6UwK5tvqsj0nGpp/XzqthkT0dqIc9g1AdtygFToNtTF67XzYS//dm+SAK9cp3B9R4ZO/46p63SCjlQ==} + engines: {node: '>=6.9.0'} + + '@babel/types@7.17.0': + resolution: {integrity: sha512-TmKSNO4D5rzhL5bjWFcVHHLETzfQ/AmbKpKPOSjlP0WoHZ6L911fgoOKY4Alp/emzG4cHJdyN49zpgkbXFEHHw==} + engines: {node: '>=6.9.0'} + + '@babel/types@7.25.6': + resolution: {integrity: sha512-/l42B1qxpG6RdfYf343Uw1vmDjeNhneUXtzhojE7pDgfpEypmRhI6j1kr17XCVv4Cgl9HdAiQY2x0GwKm7rWCw==} + engines: {node: '>=6.9.0'} + + '@chainlink/contracts@0.8.0': + resolution: {integrity: sha512-nUv1Uxw5Mn92wgLs2bgPYmo8hpdQ3s9jB/lcbdU0LmNOVu0hbfmouVnqwRLa28Ll50q6GczUA+eO0ikNIKLZsA==} + + '@colors/colors@1.5.0': + resolution: {integrity: sha512-ooWCrlZP11i8GImSjTHYHLkvFDP48nS4+204nGb1RiX/WXYHmJA2III9/e2DWVabCESdW7hBAEzHRqUn9OUVvQ==} + engines: {node: '>=0.1.90'} + + '@commitlint/cli@17.8.1': + resolution: {integrity: sha512-ay+WbzQesE0Rv4EQKfNbSMiJJ12KdKTDzIt0tcK4k11FdsWmtwP0Kp1NWMOUswfIWo6Eb7p7Ln721Nx9FLNBjg==} + engines: {node: '>=v14'} + hasBin: true + + '@commitlint/config-conventional@17.8.1': + resolution: {integrity: sha512-NxCOHx1kgneig3VLauWJcDWS40DVjg7nKOpBEEK9E5fjJpQqLCilcnKkIIjdBH98kEO1q3NpE5NSrZ2kl/QGJg==} + engines: {node: '>=v14'} + + '@commitlint/config-validator@17.8.1': + resolution: {integrity: sha512-UUgUC+sNiiMwkyiuIFR7JG2cfd9t/7MV8VB4TZ+q02ZFkHoduUS4tJGsCBWvBOGD9Btev6IecPMvlWUfJorkEA==} + engines: {node: '>=v14'} + + '@commitlint/config-validator@19.5.0': + resolution: {integrity: sha512-CHtj92H5rdhKt17RmgALhfQt95VayrUo2tSqY9g2w+laAXyk7K/Ef6uPm9tn5qSIwSmrLjKaXK9eiNuxmQrDBw==} + engines: {node: '>=v18'} + + '@commitlint/ensure@17.8.1': + resolution: {integrity: sha512-xjafwKxid8s1K23NFpL8JNo6JnY/ysetKo8kegVM7c8vs+kWLP8VrQq+NbhgVlmCojhEDbzQKp4eRXSjVOGsow==} + engines: {node: '>=v14'} + + '@commitlint/execute-rule@17.8.1': + resolution: {integrity: sha512-JHVupQeSdNI6xzA9SqMF+p/JjrHTcrJdI02PwesQIDCIGUrv04hicJgCcws5nzaoZbROapPs0s6zeVHoxpMwFQ==} + engines: {node: '>=v14'} + + '@commitlint/execute-rule@19.5.0': + resolution: {integrity: sha512-aqyGgytXhl2ejlk+/rfgtwpPexYyri4t8/n4ku6rRJoRhGZpLFMqrZ+YaubeGysCP6oz4mMA34YSTaSOKEeNrg==} + engines: {node: '>=v18'} + + '@commitlint/format@17.8.1': + resolution: {integrity: sha512-f3oMTyZ84M9ht7fb93wbCKmWxO5/kKSbwuYvS867duVomoOsgrgljkGGIztmT/srZnaiGbaK8+Wf8Ik2tSr5eg==} + engines: {node: '>=v14'} + + '@commitlint/is-ignored@17.8.1': + resolution: {integrity: sha512-UshMi4Ltb4ZlNn4F7WtSEugFDZmctzFpmbqvpyxD3la510J+PLcnyhf9chs7EryaRFJMdAKwsEKfNK0jL/QM4g==} + engines: {node: '>=v14'} + + '@commitlint/lint@17.8.1': + resolution: {integrity: sha512-aQUlwIR1/VMv2D4GXSk7PfL5hIaFSfy6hSHV94O8Y27T5q+DlDEgd/cZ4KmVI+MWKzFfCTiTuWqjfRSfdRllCA==} + engines: {node: '>=v14'} + + '@commitlint/load@17.8.1': + resolution: {integrity: sha512-iF4CL7KDFstP1kpVUkT8K2Wl17h2yx9VaR1ztTc8vzByWWcbO/WaKwxsnCOqow9tVAlzPfo1ywk9m2oJ9ucMqA==} + engines: {node: '>=v14'} + + '@commitlint/load@19.5.0': + resolution: {integrity: sha512-INOUhkL/qaKqwcTUvCE8iIUf5XHsEPCLY9looJ/ipzi7jtGhgmtH7OOFiNvwYgH7mA8osUWOUDV8t4E2HAi4xA==} + engines: {node: '>=v18'} + + '@commitlint/message@17.8.1': + resolution: {integrity: sha512-6bYL1GUQsD6bLhTH3QQty8pVFoETfFQlMn2Nzmz3AOLqRVfNNtXBaSY0dhZ0dM6A2MEq4+2d7L/2LP8TjqGRkA==} + engines: {node: '>=v14'} + + '@commitlint/parse@17.8.1': + resolution: {integrity: sha512-/wLUickTo0rNpQgWwLPavTm7WbwkZoBy3X8PpkUmlSmQJyWQTj0m6bDjiykMaDt41qcUbfeFfaCvXfiR4EGnfw==} + engines: {node: '>=v14'} + + '@commitlint/read@17.8.1': + resolution: {integrity: sha512-Fd55Oaz9irzBESPCdMd8vWWgxsW3OWR99wOntBDHgf9h7Y6OOHjWEdS9Xzen1GFndqgyoaFplQS5y7KZe0kO2w==} + engines: {node: '>=v14'} + + '@commitlint/resolve-extends@17.8.1': + resolution: {integrity: sha512-W/ryRoQ0TSVXqJrx5SGkaYuAaE/BUontL1j1HsKckvM6e5ZaG0M9126zcwL6peKSuIetJi7E87PRQF8O86EW0Q==} + engines: {node: '>=v14'} + + '@commitlint/resolve-extends@19.5.0': + resolution: {integrity: sha512-CU/GscZhCUsJwcKTJS9Ndh3AKGZTNFIOoQB2n8CmFnizE0VnEuJoum+COW+C1lNABEeqk6ssfc1Kkalm4bDklA==} + engines: {node: '>=v18'} + + '@commitlint/rules@17.8.1': + resolution: {integrity: sha512-2b7OdVbN7MTAt9U0vKOYKCDsOvESVXxQmrvuVUZ0rGFMCrCPJWWP1GJ7f0lAypbDAhaGb8zqtdOr47192LBrIA==} + engines: {node: '>=v14'} + + '@commitlint/to-lines@17.8.1': + resolution: {integrity: sha512-LE0jb8CuR/mj6xJyrIk8VLz03OEzXFgLdivBytoooKO5xLt5yalc8Ma5guTWobw998sbR3ogDd+2jed03CFmJA==} + engines: {node: '>=v14'} + + '@commitlint/top-level@17.8.1': + resolution: {integrity: sha512-l6+Z6rrNf5p333SHfEte6r+WkOxGlWK4bLuZKbtf/2TXRN+qhrvn1XE63VhD8Oe9oIHQ7F7W1nG2k/TJFhx2yA==} + engines: {node: '>=v14'} + + '@commitlint/types@17.8.1': + resolution: {integrity: sha512-PXDQXkAmiMEG162Bqdh9ChML/GJZo6vU+7F03ALKDK8zYc6SuAr47LjG7hGYRqUOz+WK0dU7bQ0xzuqFMdxzeQ==} + engines: {node: '>=v14'} + + '@commitlint/types@19.5.0': + resolution: {integrity: sha512-DSHae2obMSMkAtTBSOulg5X7/z+rGLxcXQIkg3OmWvY6wifojge5uVMydfhUvs7yQj+V7jNmRZ2Xzl8GJyqRgg==} + engines: {node: '>=v18'} + + '@cspotcode/source-map-support@0.8.1': + resolution: {integrity: sha512-IchNf6dN4tHoMFIn/7OE8LWZ19Y6q/67Bmf6vnGREv8RSbBVb9LPJxEcnwrcwX6ixSvaiGoomAUvu4YSxXrVgw==} + engines: {node: '>=12'} + + '@esbuild/aix-ppc64@0.23.1': + resolution: {integrity: sha512-6VhYk1diRqrhBAqpJEdjASR/+WVRtfjpqKuNw11cLiaWpAT/Uu+nokB+UJnevzy/P9C/ty6AOe0dwueMrGh/iQ==} + engines: {node: '>=18'} + cpu: [ppc64] + os: [aix] + + '@esbuild/android-arm64@0.23.1': + resolution: {integrity: sha512-xw50ipykXcLstLeWH7WRdQuysJqejuAGPd30vd1i5zSyKK3WE+ijzHmLKxdiCMtH1pHz78rOg0BKSYOSB/2Khw==} + engines: {node: '>=18'} + cpu: [arm64] + os: [android] + + '@esbuild/android-arm@0.23.1': + resolution: {integrity: sha512-uz6/tEy2IFm9RYOyvKl88zdzZfwEfKZmnX9Cj1BHjeSGNuGLuMD1kR8y5bteYmwqKm1tj8m4cb/aKEorr6fHWQ==} + engines: {node: '>=18'} + cpu: [arm] + os: [android] + + '@esbuild/android-x64@0.23.1': + resolution: {integrity: sha512-nlN9B69St9BwUoB+jkyU090bru8L0NA3yFvAd7k8dNsVH8bi9a8cUAUSEcEEgTp2z3dbEDGJGfP6VUnkQnlReg==} + engines: {node: '>=18'} + cpu: [x64] + os: [android] + + '@esbuild/darwin-arm64@0.23.1': + resolution: {integrity: sha512-YsS2e3Wtgnw7Wq53XXBLcV6JhRsEq8hkfg91ESVadIrzr9wO6jJDMZnCQbHm1Guc5t/CdDiFSSfWP58FNuvT3Q==} + engines: {node: '>=18'} + cpu: [arm64] + os: [darwin] + + '@esbuild/darwin-x64@0.23.1': + resolution: {integrity: sha512-aClqdgTDVPSEGgoCS8QDG37Gu8yc9lTHNAQlsztQ6ENetKEO//b8y31MMu2ZaPbn4kVsIABzVLXYLhCGekGDqw==} + engines: {node: '>=18'} + cpu: [x64] + os: [darwin] + + '@esbuild/freebsd-arm64@0.23.1': + resolution: {integrity: sha512-h1k6yS8/pN/NHlMl5+v4XPfikhJulk4G+tKGFIOwURBSFzE8bixw1ebjluLOjfwtLqY0kewfjLSrO6tN2MgIhA==} + engines: {node: '>=18'} + cpu: [arm64] + os: [freebsd] + + '@esbuild/freebsd-x64@0.23.1': + resolution: {integrity: sha512-lK1eJeyk1ZX8UklqFd/3A60UuZ/6UVfGT2LuGo3Wp4/z7eRTRYY+0xOu2kpClP+vMTi9wKOfXi2vjUpO1Ro76g==} + engines: {node: '>=18'} + cpu: [x64] + os: [freebsd] + + '@esbuild/linux-arm64@0.23.1': + resolution: {integrity: sha512-/93bf2yxencYDnItMYV/v116zff6UyTjo4EtEQjUBeGiVpMmffDNUyD9UN2zV+V3LRV3/on4xdZ26NKzn6754g==} + engines: {node: '>=18'} + cpu: [arm64] + os: [linux] + + '@esbuild/linux-arm@0.23.1': + resolution: {integrity: sha512-CXXkzgn+dXAPs3WBwE+Kvnrf4WECwBdfjfeYHpMeVxWE0EceB6vhWGShs6wi0IYEqMSIzdOF1XjQ/Mkm5d7ZdQ==} + engines: {node: '>=18'} + cpu: [arm] + os: [linux] + + '@esbuild/linux-ia32@0.23.1': + resolution: {integrity: sha512-VTN4EuOHwXEkXzX5nTvVY4s7E/Krz7COC8xkftbbKRYAl96vPiUssGkeMELQMOnLOJ8k3BY1+ZY52tttZnHcXQ==} + engines: {node: '>=18'} + cpu: [ia32] + os: [linux] + + '@esbuild/linux-loong64@0.23.1': + resolution: {integrity: sha512-Vx09LzEoBa5zDnieH8LSMRToj7ir/Jeq0Gu6qJ/1GcBq9GkfoEAoXvLiW1U9J1qE/Y/Oyaq33w5p2ZWrNNHNEw==} + engines: {node: '>=18'} + cpu: [loong64] + os: [linux] + + '@esbuild/linux-mips64el@0.23.1': + resolution: {integrity: sha512-nrFzzMQ7W4WRLNUOU5dlWAqa6yVeI0P78WKGUo7lg2HShq/yx+UYkeNSE0SSfSure0SqgnsxPvmAUu/vu0E+3Q==} + engines: {node: '>=18'} + cpu: [mips64el] + os: [linux] + + '@esbuild/linux-ppc64@0.23.1': + resolution: {integrity: sha512-dKN8fgVqd0vUIjxuJI6P/9SSSe/mB9rvA98CSH2sJnlZ/OCZWO1DJvxj8jvKTfYUdGfcq2dDxoKaC6bHuTlgcw==} + engines: {node: '>=18'} + cpu: [ppc64] + os: [linux] + + '@esbuild/linux-riscv64@0.23.1': + resolution: {integrity: sha512-5AV4Pzp80fhHL83JM6LoA6pTQVWgB1HovMBsLQ9OZWLDqVY8MVobBXNSmAJi//Csh6tcY7e7Lny2Hg1tElMjIA==} + engines: {node: '>=18'} + cpu: [riscv64] + os: [linux] + + '@esbuild/linux-s390x@0.23.1': + resolution: {integrity: sha512-9ygs73tuFCe6f6m/Tb+9LtYxWR4c9yg7zjt2cYkjDbDpV/xVn+68cQxMXCjUpYwEkze2RcU/rMnfIXNRFmSoDw==} + engines: {node: '>=18'} + cpu: [s390x] + os: [linux] + + '@esbuild/linux-x64@0.23.1': + resolution: {integrity: sha512-EV6+ovTsEXCPAp58g2dD68LxoP/wK5pRvgy0J/HxPGB009omFPv3Yet0HiaqvrIrgPTBuC6wCH1LTOY91EO5hQ==} + engines: {node: '>=18'} + cpu: [x64] + os: [linux] + + '@esbuild/netbsd-x64@0.23.1': + resolution: {integrity: sha512-aevEkCNu7KlPRpYLjwmdcuNz6bDFiE7Z8XC4CPqExjTvrHugh28QzUXVOZtiYghciKUacNktqxdpymplil1beA==} + engines: {node: '>=18'} + cpu: [x64] + os: [netbsd] + + '@esbuild/openbsd-arm64@0.23.1': + resolution: {integrity: sha512-3x37szhLexNA4bXhLrCC/LImN/YtWis6WXr1VESlfVtVeoFJBRINPJ3f0a/6LV8zpikqoUg4hyXw0sFBt5Cr+Q==} + engines: {node: '>=18'} + cpu: [arm64] + os: [openbsd] + + '@esbuild/openbsd-x64@0.23.1': + resolution: {integrity: sha512-aY2gMmKmPhxfU+0EdnN+XNtGbjfQgwZj43k8G3fyrDM/UdZww6xrWxmDkuz2eCZchqVeABjV5BpildOrUbBTqA==} + engines: {node: '>=18'} + cpu: [x64] + os: [openbsd] + + '@esbuild/sunos-x64@0.23.1': + resolution: {integrity: sha512-RBRT2gqEl0IKQABT4XTj78tpk9v7ehp+mazn2HbUeZl1YMdaGAQqhapjGTCe7uw7y0frDi4gS0uHzhvpFuI1sA==} + engines: {node: '>=18'} + cpu: [x64] + os: [sunos] + + '@esbuild/win32-arm64@0.23.1': + resolution: {integrity: sha512-4O+gPR5rEBe2FpKOVyiJ7wNDPA8nGzDuJ6gN4okSA1gEOYZ67N8JPk58tkWtdtPeLz7lBnY6I5L3jdsr3S+A6A==} + engines: {node: '>=18'} + cpu: [arm64] + os: [win32] + + '@esbuild/win32-ia32@0.23.1': + resolution: {integrity: sha512-BcaL0Vn6QwCwre3Y717nVHZbAa4UBEigzFm6VdsVdT/MbZ38xoj1X9HPkZhbmaBGUD1W8vxAfffbDe8bA6AKnQ==} + engines: {node: '>=18'} + cpu: [ia32] + os: [win32] + + '@esbuild/win32-x64@0.23.1': + resolution: {integrity: sha512-BHpFFeslkWrXWyUPnbKm+xYYVYruCinGcftSBaa8zoF9hZO4BcSCFUvHVTtzpIY6YzUnYtuEhZ+C9iEXjxnasg==} + engines: {node: '>=18'} + cpu: [x64] + os: [win32] + + '@eslint-community/eslint-utils@4.4.0': + resolution: {integrity: sha512-1/sA4dwrzBAyeUoQ6oxahHKmrZvsnLCg4RfxW3ZFGGmQkSNQPFNLV9CUEFQP1x9EYXHTo5p6xdhZM1Ne9p/AfA==} + engines: {node: ^12.22.0 || ^14.17.0 || >=16.0.0} + peerDependencies: + eslint: ^6.0.0 || ^7.0.0 || >=8.0.0 + + '@eslint-community/regexpp@4.11.0': + resolution: {integrity: sha512-G/M/tIiMrTAxEWRfLfQJMmGNX28IxBg4PBz8XqQhqUHLFI6TL2htpIB1iQCj144V5ee/JaKyT9/WZ0MGZWfA7A==} + engines: {node: ^12.0.0 || ^14.0.0 || >=16.0.0} + + '@eslint/eslintrc@2.1.4': + resolution: {integrity: sha512-269Z39MS6wVJtsoUl10L60WdkhJVdPG24Q4eZTH3nnF6lpvSShEK3wQjDX9JRWAUPvPh7COouPpU9IrqaZFvtQ==} + engines: {node: ^12.22.0 || ^14.17.0 || >=16.0.0} + + '@eslint/js@8.57.0': + resolution: {integrity: sha512-Ys+3g2TaW7gADOJzPt83SJtCDhMjndcDMFVQ/Tj9iA1BfJzFKD9mAUXT3OenpuPHbI6P/myECxRJrofUsDx/5g==} + engines: {node: ^12.22.0 || ^14.17.0 || >=16.0.0} + + '@eth-optimism/contracts@0.5.40': + resolution: {integrity: sha512-MrzV0nvsymfO/fursTB7m/KunkPsCndltVgfdHaT1Aj5Vi6R/doKIGGkOofHX+8B6VMZpuZosKCMQ5lQuqjt8w==} + peerDependencies: + ethers: ^5 + + '@eth-optimism/core-utils@0.12.0': + resolution: {integrity: sha512-qW+7LZYCz7i8dRa7SRlUKIo1VBU8lvN0HeXCxJR+z+xtMzMQpPds20XJNCMclszxYQHkXY00fOT6GvFw9ZL6nw==} + + '@ethereumjs/rlp@4.0.1': + resolution: {integrity: sha512-tqsQiBQDQdmPWE1xkkBq4rlSW5QZpLOUJ5RJh2/9fug+q9tnUhuZoVLk7s0scUIKTOzEtR72DFBXI4WiZcMpvw==} + engines: {node: '>=14'} + hasBin: true + + '@ethereumjs/util@8.1.0': + resolution: {integrity: sha512-zQ0IqbdX8FZ9aw11vP+dZkKDkS+kgIvQPHnSAXzP9pLu+Rfu3D3XEeLbicvoXJTYnhZiPmsZUxgdzXwNKxRPbA==} + engines: {node: '>=14'} + + '@ethersproject/abi@5.7.0': + resolution: {integrity: sha512-351ktp42TiRcYB3H1OP8yajPeAQstMW/yCFokj/AthP9bLHzQFPlOrxOcwYEDkUAICmOHljvN4K39OMTMUa9RA==} + + '@ethersproject/abstract-provider@5.7.0': + resolution: {integrity: sha512-R41c9UkchKCpAqStMYUpdunjo3pkEvZC3FAwZn5S5MGbXoMQOHIdHItezTETxAO5bevtMApSyEhn9+CHcDsWBw==} + + '@ethersproject/abstract-signer@5.7.0': + resolution: {integrity: sha512-a16V8bq1/Cz+TGCkE2OPMTOUDLS3grCpdjoJCYNnVBbdYEMSgKrU0+B90s8b6H+ByYTBZN7a3g76jdIJi7UfKQ==} + + '@ethersproject/address@5.6.1': + resolution: {integrity: sha512-uOgF0kS5MJv9ZvCz7x6T2EXJSzotiybApn4XlOgoTX0xdtyVIJ7pF+6cGPxiEq/dpBiTfMiw7Yc81JcwhSYA0Q==} + + '@ethersproject/address@5.7.0': + resolution: {integrity: sha512-9wYhYt7aghVGo758POM5nqcOMaE168Q6aRLJZwUmiqSrAungkG74gSSeKEIR7ukixesdRZGPgVqme6vmxs1fkA==} + + '@ethersproject/base64@5.7.0': + resolution: {integrity: sha512-Dr8tcHt2mEbsZr/mwTPIQAf3Ai0Bks/7gTw9dSqk1mQvhW3XvRlmDJr/4n+wg1JmCl16NZue17CDh8xb/vZ0sQ==} + + '@ethersproject/basex@5.7.0': + resolution: {integrity: sha512-ywlh43GwZLv2Voc2gQVTKBoVQ1mti3d8HK5aMxsfu/nRDnMmNqaSJ3r3n85HBByT8OpoY96SXM1FogC533T4zw==} + + '@ethersproject/bignumber@5.7.0': + resolution: {integrity: sha512-n1CAdIHRWjSucQO3MC1zPSVgV/6dy/fjL9pMrPP9peL+QxEg9wOsVqwD4+818B6LUEtaXzVHQiuivzRoxPxUGw==} + + '@ethersproject/bytes@5.7.0': + resolution: {integrity: sha512-nsbxwgFXWh9NyYWo+U8atvmMsSdKJprTcICAkvbBffT75qDocbuggBU0SJiVK2MuTrp0q+xvLkTnGMPK1+uA9A==} + + '@ethersproject/constants@5.7.0': + resolution: {integrity: sha512-DHI+y5dBNvkpYUMiRQyxRBYBefZkJfo70VUkUAsRjcPs47muV9evftfZ0PJVCXYbAiCgght0DtcF9srFQmIgWA==} + + '@ethersproject/contracts@5.7.0': + resolution: {integrity: sha512-5GJbzEU3X+d33CdfPhcyS+z8MzsTrBGk/sc+G+59+tPa9yFkl6HQ9D6L0QMgNTA9q8dT0XKxxkyp883XsQvbbg==} + + '@ethersproject/hash@5.7.0': + resolution: {integrity: sha512-qX5WrQfnah1EFnO5zJv1v46a8HW0+E5xuBBDTwMFZLuVTx0tbU2kkx15NqdjxecrLGatQN9FGQKpb1FKdHCt+g==} + + '@ethersproject/hdnode@5.7.0': + resolution: {integrity: sha512-OmyYo9EENBPPf4ERhR7oj6uAtUAhYGqOnIS+jE5pTXvdKBS99ikzq1E7Iv0ZQZ5V36Lqx1qZLeak0Ra16qpeOg==} + + '@ethersproject/json-wallets@5.7.0': + resolution: {integrity: sha512-8oee5Xgu6+RKgJTkvEMl2wDgSPSAQ9MB/3JYjFV9jlKvcYHUXZC+cQp0njgmxdHkYWn8s6/IqIZYm0YWCjO/0g==} + + '@ethersproject/keccak256@5.7.0': + resolution: {integrity: sha512-2UcPboeL/iW+pSg6vZ6ydF8tCnv3Iu/8tUmLLzWWGzxWKFFqOBQFLo6uLUv6BDrLgCDfN28RJ/wtByx+jZ4KBg==} + + '@ethersproject/logger@5.7.0': + resolution: {integrity: sha512-0odtFdXu/XHtjQXJYA3u9G0G8btm0ND5Cu8M7i5vhEcE8/HmF4Lbdqanwyv4uQTr2tx6b7fQRmgLrsnpQlmnig==} + + '@ethersproject/networks@5.7.1': + resolution: {integrity: sha512-n/MufjFYv3yFcUyfhnXotyDlNdFb7onmkSy8aQERi2PjNcnWQ66xXxa3XlS8nCcA8aJKJjIIMNJTC7tu80GwpQ==} + + '@ethersproject/pbkdf2@5.7.0': + resolution: {integrity: sha512-oR/dBRZR6GTyaofd86DehG72hY6NpAjhabkhxgr3X2FpJtJuodEl2auADWBZfhDHgVCbu3/H/Ocq2uC6dpNjjw==} + + '@ethersproject/properties@5.7.0': + resolution: {integrity: sha512-J87jy8suntrAkIZtecpxEPxY//szqr1mlBaYlQ0r4RCaiD2hjheqF9s1LVE8vVuJCXisjIP+JgtK/Do54ej4Sw==} + + '@ethersproject/providers@5.7.2': + resolution: {integrity: sha512-g34EWZ1WWAVgr4aptGlVBF8mhl3VWjv+8hoAnzStu8Ah22VHBsuGzP17eb6xDVRzw895G4W7vvx60lFFur/1Rg==} + + '@ethersproject/random@5.7.0': + resolution: {integrity: sha512-19WjScqRA8IIeWclFme75VMXSBvi4e6InrUNuaR4s5pTF2qNhcGdCUwdxUVGtDDqC00sDLCO93jPQoDUH4HVmQ==} + + '@ethersproject/rlp@5.7.0': + resolution: {integrity: sha512-rBxzX2vK8mVF7b0Tol44t5Tb8gomOHkj5guL+HhzQ1yBh/ydjGnpw6at+X6Iw0Kp3OzzzkcKp8N9r0W4kYSs9w==} + + '@ethersproject/sha2@5.7.0': + resolution: {integrity: sha512-gKlH42riwb3KYp0reLsFTokByAKoJdgFCwI+CCiX/k+Jm2mbNs6oOaCjYQSlI1+XBVejwH2KrmCbMAT/GnRDQw==} + + '@ethersproject/signing-key@5.7.0': + resolution: {integrity: sha512-MZdy2nL3wO0u7gkB4nA/pEf8lu1TlFswPNmy8AiYkfKTdO6eXBJyUdmHO/ehm/htHw9K/qF8ujnTyUAD+Ry54Q==} + + '@ethersproject/solidity@5.7.0': + resolution: {integrity: sha512-HmabMd2Dt/raavyaGukF4XxizWKhKQ24DoLtdNbBmNKUOPqwjsKQSdV9GQtj9CBEea9DlzETlVER1gYeXXBGaA==} + + '@ethersproject/strings@5.7.0': + resolution: {integrity: sha512-/9nu+lj0YswRNSH0NXYqrh8775XNyEdUQAuf3f+SmOrnVewcJ5SBNAjF7lpgehKi4abvNNXyf+HX86czCdJ8Mg==} + + '@ethersproject/transactions@5.7.0': + resolution: {integrity: sha512-kmcNicCp1lp8qanMTC3RIikGgoJ80ztTyvtsFvCYpSCfkjhD0jZ2LOrnbcuxuToLIUYYf+4XwD1rP+B/erDIhQ==} + + '@ethersproject/units@5.7.0': + resolution: {integrity: sha512-pD3xLMy3SJu9kG5xDGI7+xhTEmGXlEqXU4OfNapmfnxLVY4EMSSRp7j1k7eezutBPH7RBN/7QPnwR7hzNlEFeg==} + + '@ethersproject/wallet@5.7.0': + resolution: {integrity: sha512-MhmXlJXEJFBFVKrDLB4ZdDzxcBxQ3rLyCkhNqVu3CDYvR97E+8r01UgrI+TI99Le+aYm/in/0vp86guJuM7FCA==} + + '@ethersproject/web@5.7.1': + resolution: {integrity: sha512-Gueu8lSvyjBWL4cYsWsjh6MtMwM0+H4HvqFPZfB6dV8ctbP9zFAO73VG1cMWae0FLPCtz0peKPpZY8/ugJJX2w==} + + '@ethersproject/wordlists@5.7.0': + resolution: {integrity: sha512-S2TFNJNfHWVHNE6cNDjbVlZ6MgE17MIxMbMg2zv3wn+3XSJGosL1m9ZVv3GXCf/2ymSsQ+hRI5IzoMJTG6aoVA==} + + '@fastify/busboy@2.1.1': + resolution: {integrity: sha512-vBZP4NlzfOlerQTnba4aqZoMhE/a9HY7HRqoOPaETQcSQuWEIyZMHGfVu6w9wGtGK5fED5qRs2DteVCjOH60sA==} + engines: {node: '>=14'} + + '@fastify/deepmerge@1.3.0': + resolution: {integrity: sha512-J8TOSBq3SoZbDhM9+R/u77hP93gz/rajSA+K2kGyijPpORPWUXHUpTaleoj+92As0S9uPRP7Oi8IqMf0u+ro6A==} + + '@humanwhocodes/config-array@0.11.14': + resolution: {integrity: sha512-3T8LkOmg45BV5FICb15QQMsyUSWrQ8AygVfC7ZG32zOalnqrilm018ZVCw0eapXux8FtA33q8PSRSstjee3jSg==} + engines: {node: '>=10.10.0'} + deprecated: Use @eslint/config-array instead + + '@humanwhocodes/module-importer@1.0.1': + resolution: {integrity: sha512-bxveV4V8v5Yb4ncFTT3rPSgZBOpCkjfK0y4oVVVJwIuDVBRMDXrPyXRL988i5ap9m9bnyEEjWfm5WkBmtffLfA==} + engines: {node: '>=12.22'} + + '@humanwhocodes/object-schema@2.0.3': + resolution: {integrity: sha512-93zYdMES/c1D69yZiKDBj0V24vqNzB/koF26KPaagAfd3P/4gUlh3Dys5ogAK+Exi9QyzlD8x/08Zt7wIKcDcA==} + deprecated: Use @eslint/object-schema instead + + '@isaacs/cliui@8.0.2': + resolution: {integrity: sha512-O8jcjabXaleOG9DQ0+ARXWZBTfnP4WNAqzuiJK7ll44AmxGKv/J2M4TPjxjY3znBCfvBXFzucm1twdyFybFqEA==} + engines: {node: '>=12'} + + '@jridgewell/gen-mapping@0.3.5': + resolution: {integrity: sha512-IzL8ZoEDIBRWEzlCcRhOaCupYyN5gdIK+Q6fbFdPDg6HqX6jpkItn7DFIpW9LQzXG6Df9sA7+OKnq0qlz/GaQg==} + engines: {node: '>=6.0.0'} + + '@jridgewell/resolve-uri@3.1.2': + resolution: {integrity: sha512-bRISgCIjP20/tbWSPWMEi54QVPRZExkuD9lJL+UIxUKtwVJA8wW1Trb1jMs1RFXo1CBTNZ/5hpC9QvmKWdopKw==} + engines: {node: '>=6.0.0'} + + '@jridgewell/set-array@1.2.1': + resolution: {integrity: sha512-R8gLRTZeyp03ymzP/6Lil/28tGeGEzhx1q2k703KGWRAI1VdvPIXdG70VJc2pAMw3NA6JKL5hhFu1sJX0Mnn/A==} + engines: {node: '>=6.0.0'} + + '@jridgewell/sourcemap-codec@1.5.0': + resolution: {integrity: sha512-gv3ZRaISU3fjPAgNsriBRqGWQL6quFx04YMPW/zD8XMLsU32mhCCbfbO6KZFLjvYpCZ8zyDEgqsgf+PwPaM7GQ==} + + '@jridgewell/trace-mapping@0.3.25': + resolution: {integrity: sha512-vNk6aEwybGtawWmy/PzwnGDOjCkLWSD2wqvjGGAgOAwCGWySYXfYoxt00IJkTF+8Lb57DwOb3Aa0o9CApepiYQ==} + + '@jridgewell/trace-mapping@0.3.9': + resolution: {integrity: sha512-3Belt6tdc8bPgAtbcmdtNJlirVoTmEb5e2gC94PnkwEW9jI6CAHUeoG85tjWP5WquqfavoMtMwiG4P926ZKKuQ==} + + '@looksrare/contracts-libs@3.5.1': + resolution: {integrity: sha512-grKSOYJS6iSwS3zrrR3v/RWUbJW+y7P0gg3GakA5A0kfQrzxK8wYpOqaOyAAOzS7/Yy9ToWnGpzYTr6YXz7olQ==} + engines: {node: '>=8.3.0'} + + '@metamask/eth-sig-util@4.0.1': + resolution: {integrity: sha512-tghyZKLHZjcdlDqCA3gNZmLeR0XvOE9U1qoQO9ohyAZT6Pya+H9vkBPcsyXytmYLNgVoin7CKCmweo/R43V+tQ==} + engines: {node: '>=12.0.0'} + + '@noble/curves@1.2.0': + resolution: {integrity: sha512-oYclrNgRaM9SsBUBVbb8M6DTV7ZHRTKugureoYEncY5c65HOmRzvSiTE3y5CYaPYJA/GVkrhXEoF0M3Ya9PMnw==} + + '@noble/curves@1.4.0': + resolution: {integrity: sha512-p+4cb332SFCrReJkCYe8Xzm0OWi4Jji5jVdIZRL/PmacmDkFNw6MrrV+gGpiPxLHbV+zKFRywUWbaseT+tZRXg==} + + '@noble/curves@1.4.2': + resolution: {integrity: sha512-TavHr8qycMChk8UwMld0ZDRvatedkzWfH8IiaeGCfymOP5i0hSCozz9vHOL0nkwk7HRMlFnAiKpS2jrUmSybcw==} + + '@noble/hashes@1.2.0': + resolution: {integrity: sha512-FZfhjEDbT5GRswV3C6uvLPHMiVD6lQBmpoX5+eSiPaMTXte/IKqI5dykDxzZB/WBeK/CDuQRBWarPdi3FNY2zQ==} + + '@noble/hashes@1.3.2': + resolution: {integrity: sha512-MVC8EAQp7MvEcm30KWENFjgR+Mkmf+D189XJTkFIlwohU5hcBbn1ZkKq7KVTi2Hme3PMGF390DaL52beVrIihQ==} + engines: {node: '>= 16'} + + '@noble/hashes@1.4.0': + resolution: {integrity: sha512-V1JJ1WTRUqHHrOSh597hURcMqVKVGL/ea3kv0gSnEdsEZ0/+VyPghM1lMNGc00z7CIQorSvbKpuJkxvuHbvdbg==} + engines: {node: '>= 16'} + + '@noble/hashes@1.5.0': + resolution: {integrity: sha512-1j6kQFb7QRru7eKN3ZDvRcP13rugwdxZqCjbiAVZfIJwgj2A65UmT4TgARXGlXgnRkORLTDTrO19ZErt7+QXgA==} + engines: {node: ^14.21.3 || >=16} + + '@noble/secp256k1@1.7.1': + resolution: {integrity: sha512-hOUk6AyBFmqVrv7k5WAw/LpszxVbj9gGN4JRkIX52fdFAj1UA61KXmZDvqVEm+pOyec3+fIeZB02LYa/pWOArw==} + + '@nodelib/fs.scandir@2.1.5': + resolution: {integrity: sha512-vq24Bq3ym5HEQm2NKCr3yXDwjc7vTsEThRDnkp2DK9p1uqLR+DHurm/NOTo0KG7HYHU7eppKZj3MyqYuMBf62g==} + engines: {node: '>= 8'} + + '@nodelib/fs.stat@2.0.5': + resolution: {integrity: sha512-RkhPPp2zrqDAQA/2jNhnztcPAlv64XdhIp7a7454A5ovI7Bukxgt7MX7udwAu3zg1DcpPU0rz3VV1SeaqvY4+A==} + engines: {node: '>= 8'} + + '@nodelib/fs.walk@1.2.8': + resolution: {integrity: sha512-oGB+UxlgWcgQkgwo8GcEGwemoTFt3FIO9ababBmaGwXIoBKZ+GTy0pP185beGg7Llih/NSHSV2XAs1lnznocSg==} + engines: {node: '>= 8'} + + '@nomicfoundation/edr-darwin-arm64@0.5.2': + resolution: {integrity: sha512-Gm4wOPKhbDjGTIRyFA2QUAPfCXA1AHxYOKt3yLSGJkQkdy9a5WW+qtqKeEKHc/+4wpJSLtsGQfpzyIzggFfo/A==} + engines: {node: '>= 18'} + + '@nomicfoundation/edr-darwin-x64@0.5.2': + resolution: {integrity: sha512-ClyABq2dFCsrYEED3/UIO0c7p4H1/4vvlswFlqUyBpOkJccr75qIYvahOSJRM62WgUFRhbSS0OJXFRwc/PwmVg==} + engines: {node: '>= 18'} + + '@nomicfoundation/edr-linux-arm64-gnu@0.5.2': + resolution: {integrity: sha512-HWMTVk1iOabfvU2RvrKLDgtFjJZTC42CpHiw2h6rfpsgRqMahvIlx2jdjWYzFNy1jZKPTN1AStQ/91MRrg5KnA==} + engines: {node: '>= 18'} + + '@nomicfoundation/edr-linux-arm64-musl@0.5.2': + resolution: {integrity: sha512-CwsQ10xFx/QAD5y3/g5alm9+jFVuhc7uYMhrZAu9UVF+KtVjeCvafj0PaVsZ8qyijjqVuVsJ8hD1x5ob7SMcGg==} + engines: {node: '>= 18'} + + '@nomicfoundation/edr-linux-x64-gnu@0.5.2': + resolution: {integrity: sha512-CWVCEdhWJ3fmUpzWHCRnC0/VLBDbqtqTGTR6yyY1Ep3S3BOrHEAvt7h5gx85r2vLcztisu2vlDq51auie4IU1A==} + engines: {node: '>= 18'} + + '@nomicfoundation/edr-linux-x64-musl@0.5.2': + resolution: {integrity: sha512-+aJDfwhkddy2pP5u1ISg3IZVAm0dO836tRlDTFWtvvSMQ5hRGqPcWwlsbobhDQsIxhPJyT7phL0orCg5W3WMeA==} + engines: {node: '>= 18'} + + '@nomicfoundation/edr-win32-x64-msvc@0.5.2': + resolution: {integrity: sha512-CcvvuA3sAv7liFNPsIR/68YlH6rrybKzYttLlMr80d4GKJjwJ5OKb3YgE6FdZZnOfP19HEHhsLcE0DPLtY3r0w==} + engines: {node: '>= 18'} + + '@nomicfoundation/edr@0.5.2': + resolution: {integrity: sha512-hW/iLvUQZNTVjFyX/I40rtKvvDOqUEyIi96T28YaLfmPL+3LW2lxmYLUXEJ6MI14HzqxDqrLyhf6IbjAa2r3Dw==} + engines: {node: '>= 18'} + + '@nomicfoundation/ethereumjs-common@4.0.4': + resolution: {integrity: sha512-9Rgb658lcWsjiicr5GzNCjI1llow/7r0k50dLL95OJ+6iZJcVbi15r3Y0xh2cIO+zgX0WIHcbzIu6FeQf9KPrg==} + + '@nomicfoundation/ethereumjs-rlp@5.0.4': + resolution: {integrity: sha512-8H1S3s8F6QueOc/X92SdrA4RDenpiAEqMg5vJH99kcQaCy/a3Q6fgseo75mgWlbanGJXSlAPtnCeG9jvfTYXlw==} + engines: {node: '>=18'} + hasBin: true + + '@nomicfoundation/ethereumjs-tx@5.0.4': + resolution: {integrity: sha512-Xjv8wAKJGMrP1f0n2PeyfFCCojHd7iS3s/Ab7qzF1S64kxZ8Z22LCMynArYsVqiFx6rzYy548HNVEyI+AYN/kw==} + engines: {node: '>=18'} + peerDependencies: + c-kzg: ^2.1.2 + peerDependenciesMeta: + c-kzg: + optional: true + + '@nomicfoundation/ethereumjs-util@9.0.4': + resolution: {integrity: sha512-sLOzjnSrlx9Bb9EFNtHzK/FJFsfg2re6bsGqinFinH1gCqVfz9YYlXiMWwDM4C/L4ywuHFCYwfKTVr/QHQcU0Q==} + engines: {node: '>=18'} + peerDependencies: + c-kzg: ^2.1.2 + peerDependenciesMeta: + c-kzg: + optional: true + + '@nomicfoundation/hardhat-chai-matchers@2.0.7': + resolution: {integrity: sha512-RQfsiTwdf0SP+DtuNYvm4921X6VirCQq0Xyh+mnuGlTwEFSPZ/o27oQC+l+3Y/l48DDU7+ZcYBR+Fp+Rp94LfQ==} + peerDependencies: + '@nomicfoundation/hardhat-ethers': ^3.0.0 + chai: ^4.2.0 + ethers: ^6.1.0 + hardhat: ^2.9.4 + + '@nomicfoundation/hardhat-ethers@3.0.8': + resolution: {integrity: sha512-zhOZ4hdRORls31DTOqg+GmEZM0ujly8GGIuRY7t7szEk2zW/arY1qDug/py8AEktT00v5K+b6RvbVog+va51IA==} + peerDependencies: + ethers: ^6.1.0 + hardhat: ^2.0.0 + + '@nomicfoundation/hardhat-ignition-ethers@0.15.5': + resolution: {integrity: sha512-W6s1QN9CFxzSVZS6w9Jcj3WLaK32z2FP5MxNU2OKY1Fn9ZzLr+miXbUbWYuRHl6dxrrl6sE8cv33Cybv19pmCg==} + peerDependencies: + '@nomicfoundation/hardhat-ethers': ^3.0.4 + '@nomicfoundation/hardhat-ignition': ^0.15.5 + '@nomicfoundation/ignition-core': ^0.15.5 + ethers: ^6.7.0 + hardhat: ^2.18.0 + + '@nomicfoundation/hardhat-ignition@0.15.5': + resolution: {integrity: sha512-Y5nhFXFqt4owA6Ooag8ZBFDF2RAZElMXViknVIsi3m45pbQimS50ti6FU8HxfRkDnBARa40CIn7UGV0hrelzDw==} + peerDependencies: + '@nomicfoundation/hardhat-verify': ^2.0.1 + hardhat: ^2.18.0 + + '@nomicfoundation/hardhat-network-helpers@1.0.11': + resolution: {integrity: sha512-uGPL7QSKvxrHRU69dx8jzoBvuztlLCtyFsbgfXIwIjnO3dqZRz2GNMHJoO3C3dIiUNM6jdNF4AUnoQKDscdYrA==} + peerDependencies: + hardhat: ^2.9.5 + + '@nomicfoundation/hardhat-toolbox@5.0.0': + resolution: {integrity: sha512-FnUtUC5PsakCbwiVNsqlXVIWG5JIb5CEZoSXbJUsEBun22Bivx2jhF1/q9iQbzuaGpJKFQyOhemPB2+XlEE6pQ==} + peerDependencies: + '@nomicfoundation/hardhat-chai-matchers': ^2.0.0 + '@nomicfoundation/hardhat-ethers': ^3.0.0 + '@nomicfoundation/hardhat-ignition-ethers': ^0.15.0 + '@nomicfoundation/hardhat-network-helpers': ^1.0.0 + '@nomicfoundation/hardhat-verify': ^2.0.0 + '@typechain/ethers-v6': ^0.5.0 + '@typechain/hardhat': ^9.0.0 + '@types/chai': ^4.2.0 + '@types/mocha': '>=9.1.0' + '@types/node': '>=18.0.0' + chai: ^4.2.0 + ethers: ^6.4.0 + hardhat: ^2.11.0 + hardhat-gas-reporter: ^1.0.8 + solidity-coverage: ^0.8.1 + ts-node: '>=8.0.0' + typechain: ^8.3.0 + typescript: '>=4.5.0' + + '@nomicfoundation/hardhat-verify@2.0.10': + resolution: {integrity: sha512-3zoTZGQhpeOm6piJDdsGb6euzZAd7N5Tk0zPQvGnfKQ0+AoxKz/7i4if12goi8IDTuUGElAUuZyQB8PMQoXA5g==} + peerDependencies: + hardhat: ^2.0.4 + + '@nomicfoundation/hardhat-viem@2.0.4': + resolution: {integrity: sha512-+L8bOZc7yQKkGxhEARhecrNRG2mxu4bZmNJyvKg9Teig0SOim5j8h3iFdVVx6u9Lc9DIVDDY6P1Vpb8P8tKZVQ==} + peerDependencies: + hardhat: ^2.17.0 + typescript: ~5.0.0 + viem: ^2.7.6 + + '@nomicfoundation/ignition-core@0.15.5': + resolution: {integrity: sha512-FgvuoIXhakRSP524JzNQ4BviyzBBKpsFaOWubPZ4XACLT4/7vGqlJ/7DIn0D2NL2anQ2qs98/BNBY9WccXUX1Q==} + + '@nomicfoundation/ignition-ui@0.15.5': + resolution: {integrity: sha512-ZcE4rIn10qKahR4OqS8rl8NM2Fbg2QYiBXgMgj74ZI0++LlCcZgB5HyaBbX+lsnKHjTXtjYD3b+2mtg7jFbAMQ==} + + '@nomicfoundation/slang-darwin-arm64@0.17.0': + resolution: {integrity: sha512-O0q94EUtoWy9A5kOTOa9/khtxXDYnLqmuda9pQELurSiwbQEVCPQL8kb34VbOW+ifdre66JM/05Xw9JWhIZ9sA==} + engines: {node: '>= 10'} + + '@nomicfoundation/slang-darwin-x64@0.17.0': + resolution: {integrity: sha512-IaDbHzvT08sBK2HyGzonWhq1uu8IxdjmTqAWHr25Oh/PYnamdi8u4qchZXXYKz/DHLoYN3vIpBXoqLQIomhD/g==} + engines: {node: '>= 10'} + + '@nomicfoundation/slang-linux-arm64-gnu@0.17.0': + resolution: {integrity: sha512-Lj4anvOsQZxs1SycG8VyT2Rl2oqIhyLSUCgGepTt3CiJ/bM+8r8bLJIgh8vKkki4BWz49YsYIgaJB2IPv8FFTw==} + engines: {node: '>= 10'} + + '@nomicfoundation/slang-linux-arm64-musl@0.17.0': + resolution: {integrity: sha512-/xkTCa9d5SIWUBQE3BmLqDFfJRr4yUBwbl4ynPiGUpRXrD69cs6pWKkwjwz/FdBpXqVo36I+zY95qzoTj/YhOA==} + engines: {node: '>= 10'} + + '@nomicfoundation/slang-linux-x64-gnu@0.17.0': + resolution: {integrity: sha512-oe5IO5vntOqYvTd67deCHPIWuSuWm6aYtT2/0Kqz2/VLtGz4ClEulBSRwfnNzBVtw2nksWipE1w8BzhImI7Syg==} + engines: {node: '>= 10'} + + '@nomicfoundation/slang-linux-x64-musl@0.17.0': + resolution: {integrity: sha512-PpYCI5K/kgLAMXaPY0V4VST5gCDprEOh7z/47tbI8kJQumI5odjsj/Cs8MpTo7/uRH6flKYbVNgUzcocWVYrAQ==} + engines: {node: '>= 10'} + + '@nomicfoundation/slang-win32-arm64-msvc@0.17.0': + resolution: {integrity: sha512-u/Mkf7OjokdBilP7QOJj6QYJU4/mjkbKnTX21wLyCIzeVWS7yafRPYpBycKIBj2pRRZ6ceAY5EqRpb0aiCq+0Q==} + engines: {node: '>= 10'} + + '@nomicfoundation/slang-win32-ia32-msvc@0.17.0': + resolution: {integrity: sha512-XJBVQfNnZQUv0tP2JSJ573S+pmgrLWgqSZOGaMllnB/TL1gRci4Z7dYRJUF2s82GlRJE+FHSI2Ro6JISKmlXCg==} + engines: {node: '>= 10'} + + '@nomicfoundation/slang-win32-x64-msvc@0.17.0': + resolution: {integrity: sha512-zPGsAeiTfqfPNYHD8BfrahQmYzA78ZraoHKTGraq/1xwJwzBK4bu/NtvVA4pJjBV+B4L6DCxVhSbpn40q26JQA==} + engines: {node: '>= 10'} + + '@nomicfoundation/slang@0.17.0': + resolution: {integrity: sha512-1GlkGRcGpVnjFw9Z1vvDKOKo2mzparFt7qrl2pDxWp+jrVtlvej98yCMX52pVyrYE7ZeOSZFnx/DtsSgoukStQ==} + engines: {node: '>= 10'} + + '@nomicfoundation/solidity-analyzer-darwin-arm64@0.1.2': + resolution: {integrity: sha512-JaqcWPDZENCvm++lFFGjrDd8mxtf+CtLd2MiXvMNTBD33dContTZ9TWETwNFwg7JTJT5Q9HEecH7FA+HTSsIUw==} + engines: {node: '>= 12'} + + '@nomicfoundation/solidity-analyzer-darwin-x64@0.1.2': + resolution: {integrity: sha512-fZNmVztrSXC03e9RONBT+CiksSeYcxI1wlzqyr0L7hsQlK1fzV+f04g2JtQ1c/Fe74ZwdV6aQBdd6Uwl1052sw==} + engines: {node: '>= 12'} + + '@nomicfoundation/solidity-analyzer-linux-arm64-gnu@0.1.2': + resolution: {integrity: sha512-3d54oc+9ZVBuB6nbp8wHylk4xh0N0Gc+bk+/uJae+rUgbOBwQSfuGIbAZt1wBXs5REkSmynEGcqx6DutoK0tPA==} + engines: {node: '>= 12'} + + '@nomicfoundation/solidity-analyzer-linux-arm64-musl@0.1.2': + resolution: {integrity: sha512-iDJfR2qf55vgsg7BtJa7iPiFAsYf2d0Tv/0B+vhtnI16+wfQeTbP7teookbGvAo0eJo7aLLm0xfS/GTkvHIucA==} + engines: {node: '>= 12'} + + '@nomicfoundation/solidity-analyzer-linux-x64-gnu@0.1.2': + resolution: {integrity: sha512-9dlHMAt5/2cpWyuJ9fQNOUXFB/vgSFORg1jpjX1Mh9hJ/MfZXlDdHQ+DpFCs32Zk5pxRBb07yGvSHk9/fezL+g==} + engines: {node: '>= 12'} + + '@nomicfoundation/solidity-analyzer-linux-x64-musl@0.1.2': + resolution: {integrity: sha512-GzzVeeJob3lfrSlDKQw2bRJ8rBf6mEYaWY+gW0JnTDHINA0s2gPR4km5RLIj1xeZZOYz4zRw+AEeYgLRqB2NXg==} + engines: {node: '>= 12'} + + '@nomicfoundation/solidity-analyzer-win32-x64-msvc@0.1.2': + resolution: {integrity: sha512-Fdjli4DCcFHb4Zgsz0uEJXZ2K7VEO+w5KVv7HmT7WO10iODdU9csC2az4jrhEsRtiR9Gfd74FlG0NYlw1BMdyA==} + engines: {node: '>= 12'} + + '@nomicfoundation/solidity-analyzer@0.1.2': + resolution: {integrity: sha512-q4n32/FNKIhQ3zQGGw5CvPF6GTvDCpYwIf7bEY/dZTZbgfDsHyjJwURxUJf3VQuuJj+fDIFl4+KkBVbw4Ef6jA==} + engines: {node: '>= 12'} + + '@openzeppelin/contracts-upgradeable@4.7.3': + resolution: {integrity: sha512-+wuegAMaLcZnLCJIvrVUDzA9z/Wp93f0Dla/4jJvIhijRrPabjQbZe6fWiECLaJyfn5ci9fqf9vTw3xpQOad2A==} + + '@openzeppelin/contracts@3.4.2': + resolution: {integrity: sha512-z0zMCjyhhp4y7XKAcDAi3Vgms4T2PstwBdahiO0+9NaGICQKjynK3wduSRplTgk4LXmoO1yfDGO5RbjKYxtuxA==} + + '@openzeppelin/contracts@4.3.3': + resolution: {integrity: sha512-tDBopO1c98Yk7Cv/PZlHqrvtVjlgK5R4J6jxLwoO7qxK4xqOiZG+zSkIvGFpPZ0ikc3QOED3plgdqjgNTnBc7g==} + + '@openzeppelin/contracts@4.9.6': + resolution: {integrity: sha512-xSmezSupL+y9VkHZJGDoCBpmnB2ogM13ccaYDWqJTfS3dbuHkgjuwDFUmaFauBCboQMGB/S5UqUl2y54X99BmA==} + + '@openzeppelin/defender-sdk-base-client@1.14.4': + resolution: {integrity: sha512-tOePVQLKpqfGQ1GMzHvSBNd2psPYd86LDNpvdl5gjD0Y2kW/zNh5qBXy29RraGtk/qc8zs9hzS5pAOh0vhGkGQ==} + + '@openzeppelin/defender-sdk-deploy-client@1.14.4': + resolution: {integrity: sha512-+diSoz1zid37LMsY2RDxI+uAsYx9Eryg8Vz+yfvuyd56fXrzjQEln7BBtYQw+2zp9yvyAByOL5XSQdrQga9OBQ==} + + '@openzeppelin/defender-sdk-network-client@1.14.4': + resolution: {integrity: sha512-OS0H5b0vgYacJcwkvUFJUaRuyUaXhIRl916W5xLvGia5H6i/qn3dP8MZ7oLcPwKc8jB+ucRytO4H/AHsea0aVA==} + + '@openzeppelin/hardhat-upgrades@3.2.1': + resolution: {integrity: sha512-Zy5M3QhkzwGdpzQmk+xbWdYOGJWjoTvwbBKYLhctu9B91DoprlhDRaZUwCtunwTdynkTDGdVfGr0kIkvycyKjw==} + hasBin: true + peerDependencies: + '@nomicfoundation/hardhat-ethers': ^3.0.0 + '@nomicfoundation/hardhat-verify': ^2.0.0 + ethers: ^6.6.0 + hardhat: ^2.0.2 + peerDependenciesMeta: + '@nomicfoundation/hardhat-verify': + optional: true + + '@openzeppelin/upgrades-core@1.37.1': + resolution: {integrity: sha512-dMQPDoMn1OUZXsCHT1thnAmkZ14v0FNlst5Ej8MIfujOv0k74kUok5XeuNF42fYewnNUYMkkz3PhXU1OIwSeyg==} + hasBin: true + + '@pkgjs/parseargs@0.11.0': + resolution: {integrity: sha512-+1VkjdD0QBLPodGrJUeqarH8VAIvQODIbwh9XpP5Syisf7YoQgsJKPNFoqqLQlu+VQ/tVSshMR6loPMn8U+dPg==} + engines: {node: '>=14'} + + '@primitivefi/hardhat-dodoc@0.2.3': + resolution: {integrity: sha512-ver9uHa79LTDTeebOKZ/eOVRL/FP1k0s0x/5Bo/8ZaDdLWFVClKqZyZYVjjW4CJqTPCt8uU9b9p71P2vzH4O9A==} + peerDependencies: + hardhat: ^2.6.4 + squirrelly: ^8.0.8 + + '@rollup/plugin-commonjs@24.1.0': + resolution: {integrity: sha512-eSL45hjhCWI0jCCXcNtLVqM5N1JlBGvlFfY0m6oOYnLCJ6N0qEXoZql4sY2MOUArzhH4SA/qBpTxvvZp2Sc+DQ==} + engines: {node: '>=14.0.0'} + peerDependencies: + rollup: ^2.68.0||^3.0.0 + peerDependenciesMeta: + rollup: + optional: true + + '@rollup/plugin-json@6.1.0': + resolution: {integrity: sha512-EGI2te5ENk1coGeADSIwZ7G2Q8CJS2sF120T7jLw4xFw9n7wIOXHo+kIYRAoVpJAN+kmqZSoO3Fp4JtoNF4ReA==} + engines: {node: '>=14.0.0'} + peerDependencies: + rollup: ^1.20.0||^2.0.0||^3.0.0||^4.0.0 + peerDependenciesMeta: + rollup: + optional: true + + '@rollup/plugin-node-resolve@15.2.3': + resolution: {integrity: sha512-j/lym8nf5E21LwBT4Df1VD6hRO2L2iwUeUmP7litikRsVp1H6NWx20NEp0Y7su+7XGc476GnXXc4kFeZNGmaSQ==} + engines: {node: '>=14.0.0'} + peerDependencies: + rollup: ^2.78.0||^3.0.0||^4.0.0 + peerDependenciesMeta: + rollup: + optional: true + + '@rollup/pluginutils@5.1.0': + resolution: {integrity: sha512-XTIWOPPcpvyKI6L1NHo0lFlCyznUEyPmPY1mc3KpPVDYulHSTvyeLNVW00QTLIAFNhR3kYnJTQHeGqU4M3n09g==} + engines: {node: '>=14.0.0'} + peerDependencies: + rollup: ^1.20.0||^2.0.0||^3.0.0||^4.0.0 + peerDependenciesMeta: + rollup: + optional: true + + '@rollup/rollup-android-arm-eabi@4.21.2': + resolution: {integrity: sha512-fSuPrt0ZO8uXeS+xP3b+yYTCBUd05MoSp2N/MFOgjhhUhMmchXlpTQrTpI8T+YAwAQuK7MafsCOxW7VrPMrJcg==} + cpu: [arm] + os: [android] + + '@rollup/rollup-android-arm64@4.21.2': + resolution: {integrity: sha512-xGU5ZQmPlsjQS6tzTTGwMsnKUtu0WVbl0hYpTPauvbRAnmIvpInhJtgjj3mcuJpEiuUw4v1s4BimkdfDWlh7gA==} + cpu: [arm64] + os: [android] + + '@rollup/rollup-darwin-arm64@4.21.2': + resolution: {integrity: sha512-99AhQ3/ZMxU7jw34Sq8brzXqWH/bMnf7ZVhvLk9QU2cOepbQSVTns6qoErJmSiAvU3InRqC2RRZ5ovh1KN0d0Q==} + cpu: [arm64] + os: [darwin] + + '@rollup/rollup-darwin-x64@4.21.2': + resolution: {integrity: sha512-ZbRaUvw2iN/y37x6dY50D8m2BnDbBjlnMPotDi/qITMJ4sIxNY33HArjikDyakhSv0+ybdUxhWxE6kTI4oX26w==} + cpu: [x64] + os: [darwin] + + '@rollup/rollup-linux-arm-gnueabihf@4.21.2': + resolution: {integrity: sha512-ztRJJMiE8nnU1YFcdbd9BcH6bGWG1z+jP+IPW2oDUAPxPjo9dverIOyXz76m6IPA6udEL12reYeLojzW2cYL7w==} + cpu: [arm] + os: [linux] + + '@rollup/rollup-linux-arm-musleabihf@4.21.2': + resolution: {integrity: sha512-flOcGHDZajGKYpLV0JNc0VFH361M7rnV1ee+NTeC/BQQ1/0pllYcFmxpagltANYt8FYf9+kL6RSk80Ziwyhr7w==} + cpu: [arm] + os: [linux] + + '@rollup/rollup-linux-arm64-gnu@4.21.2': + resolution: {integrity: sha512-69CF19Kp3TdMopyteO/LJbWufOzqqXzkrv4L2sP8kfMaAQ6iwky7NoXTp7bD6/irKgknDKM0P9E/1l5XxVQAhw==} + cpu: [arm64] + os: [linux] + + '@rollup/rollup-linux-arm64-musl@4.21.2': + resolution: {integrity: sha512-48pD/fJkTiHAZTnZwR0VzHrao70/4MlzJrq0ZsILjLW/Ab/1XlVUStYyGt7tdyIiVSlGZbnliqmult/QGA2O2w==} + cpu: [arm64] + os: [linux] + + '@rollup/rollup-linux-powerpc64le-gnu@4.21.2': + resolution: {integrity: sha512-cZdyuInj0ofc7mAQpKcPR2a2iu4YM4FQfuUzCVA2u4HI95lCwzjoPtdWjdpDKyHxI0UO82bLDoOaLfpZ/wviyQ==} + cpu: [ppc64] + os: [linux] + + '@rollup/rollup-linux-riscv64-gnu@4.21.2': + resolution: {integrity: sha512-RL56JMT6NwQ0lXIQmMIWr1SW28z4E4pOhRRNqwWZeXpRlykRIlEpSWdsgNWJbYBEWD84eocjSGDu/XxbYeCmwg==} + cpu: [riscv64] + os: [linux] + + '@rollup/rollup-linux-s390x-gnu@4.21.2': + resolution: {integrity: sha512-PMxkrWS9z38bCr3rWvDFVGD6sFeZJw4iQlhrup7ReGmfn7Oukrr/zweLhYX6v2/8J6Cep9IEA/SmjXjCmSbrMQ==} + cpu: [s390x] + os: [linux] + + '@rollup/rollup-linux-x64-gnu@4.21.2': + resolution: {integrity: sha512-B90tYAUoLhU22olrafY3JQCFLnT3NglazdwkHyxNDYF/zAxJt5fJUB/yBoWFoIQ7SQj+KLe3iL4BhOMa9fzgpw==} + cpu: [x64] + os: [linux] + + '@rollup/rollup-linux-x64-musl@4.21.2': + resolution: {integrity: sha512-7twFizNXudESmC9oneLGIUmoHiiLppz/Xs5uJQ4ShvE6234K0VB1/aJYU3f/4g7PhssLGKBVCC37uRkkOi8wjg==} + cpu: [x64] + os: [linux] + + '@rollup/rollup-win32-arm64-msvc@4.21.2': + resolution: {integrity: sha512-9rRero0E7qTeYf6+rFh3AErTNU1VCQg2mn7CQcI44vNUWM9Ze7MSRS/9RFuSsox+vstRt97+x3sOhEey024FRQ==} + cpu: [arm64] + os: [win32] + + '@rollup/rollup-win32-ia32-msvc@4.21.2': + resolution: {integrity: sha512-5rA4vjlqgrpbFVVHX3qkrCo/fZTj1q0Xxpg+Z7yIo3J2AilW7t2+n6Q8Jrx+4MrYpAnjttTYF8rr7bP46BPzRw==} + cpu: [ia32] + os: [win32] + + '@rollup/rollup-win32-x64-msvc@4.21.2': + resolution: {integrity: sha512-6UUxd0+SKomjdzuAcp+HAmxw1FlGBnl1v2yEPSabtx4lBfdXHDVsW7+lQkgz9cNFJGY3AWR7+V8P5BqkD9L9nA==} + cpu: [x64] + os: [win32] + + '@scure/base@1.1.8': + resolution: {integrity: sha512-6CyAclxj3Nb0XT7GHK6K4zK6k2xJm6E4Ft0Ohjt4WgegiFUHEtFb2CGzmPmGBwoIhrLsqNLYfLr04Y1GePrzZg==} + + '@scure/bip32@1.1.5': + resolution: {integrity: sha512-XyNh1rB0SkEqd3tXcXMi+Xe1fvg+kUIcoRIEujP1Jgv7DqW2r9lg3Ah0NkFaCs9sTkQAQA8kw7xiRXzENi9Rtw==} + + '@scure/bip32@1.4.0': + resolution: {integrity: sha512-sVUpc0Vq3tXCkDGYVWGIZTRfnvu8LoTDaev7vbwh0omSvVORONr960MQWdKqJDCReIEmTj3PAr73O3aoxz7OPg==} + + '@scure/bip39@1.1.1': + resolution: {integrity: sha512-t+wDck2rVkh65Hmv280fYdVdY25J9YeEUIgn2LG1WM6gxFkGzcksoDiUkWVpVp3Oex9xGC68JU2dSbUfwZ2jPg==} + + '@scure/bip39@1.3.0': + resolution: {integrity: sha512-disdg7gHuTDZtY+ZdkmLpPCk7fxZSu3gBiEGuoC1XYxv9cGx3Z6cpTggCgW6odSOOIXCiDjuGejW+aJKCY/pIQ==} + + '@scure/bip39@1.4.0': + resolution: {integrity: sha512-BEEm6p8IueV/ZTfQLp/0vhw4NPnT9oWf5+28nvmeUICjP99f4vr2d+qc7AVGDDtwRep6ifR43Yed9ERVmiITzw==} + + '@sentry/core@5.30.0': + resolution: {integrity: sha512-TmfrII8w1PQZSZgPpUESqjB+jC6MvZJZdLtE/0hZ+SrnKhW3x5WlYLvTXZpcWePYBku7rl2wn1RZu6uT0qCTeg==} + engines: {node: '>=6'} + + '@sentry/hub@5.30.0': + resolution: {integrity: sha512-2tYrGnzb1gKz2EkMDQcfLrDTvmGcQPuWxLnJKXJvYTQDGLlEvi2tWz1VIHjunmOvJrB5aIQLhm+dcMRwFZDCqQ==} + engines: {node: '>=6'} + + '@sentry/minimal@5.30.0': + resolution: {integrity: sha512-BwWb/owZKtkDX+Sc4zCSTNcvZUq7YcH3uAVlmh/gtR9rmUvbzAA3ewLuB3myi4wWRAMEtny6+J/FN/x+2wn9Xw==} + engines: {node: '>=6'} + + '@sentry/node@5.30.0': + resolution: {integrity: sha512-Br5oyVBF0fZo6ZS9bxbJZG4ApAjRqAnqFFurMVJJdunNb80brh7a5Qva2kjhm+U6r9NJAB5OmDyPkA1Qnt+QVg==} + engines: {node: '>=6'} + + '@sentry/tracing@5.30.0': + resolution: {integrity: sha512-dUFowCr0AIMwiLD7Fs314Mdzcug+gBVo/+NCMyDw8tFxJkwWAKl7Qa2OZxLQ0ZHjakcj1hNKfCQJ9rhyfOl4Aw==} + engines: {node: '>=6'} + + '@sentry/types@5.30.0': + resolution: {integrity: sha512-R8xOqlSTZ+htqrfteCWU5Nk0CDN5ApUTvrlvBuiH1DyP6czDZ4ktbZB0hAgBlVcK0U+qpD3ag3Tqqpa5Q67rPw==} + engines: {node: '>=6'} + + '@sentry/utils@5.30.0': + resolution: {integrity: sha512-zaYmoH0NWWtvnJjC9/CBseXMtKHm/tm40sz3YfJRxeQjyzRqNQPgivpd9R/oDJCYj999mzdW382p/qi2ypjLww==} + engines: {node: '>=6'} + + '@smithy/types@3.4.0': + resolution: {integrity: sha512-0shOWSg/pnFXPcsSU8ZbaJ4JBHZJPPzLCJxafJvbMVFo9l1w81CqpgUqjlKGNHVrVB7fhIs+WS82JDTyzaLyLA==} + engines: {node: '>=16.0.0'} + + '@solidity-parser/parser@0.14.5': + resolution: {integrity: sha512-6dKnHZn7fg/iQATVEzqyUOyEidbn05q7YA2mQ9hC0MMXhhV3/JrsxmFSYZAcr7j1yUP700LLhTruvJ3MiQmjJg==} + + '@solidity-parser/parser@0.16.2': + resolution: {integrity: sha512-PI9NfoA3P8XK2VBkK5oIfRgKDsicwDZfkVq9ZTBCQYGOP1N2owgY2dyLGyU5/J/hQs8KRk55kdmvTLjy3Mu3vg==} + + '@solidity-parser/parser@0.18.0': + resolution: {integrity: sha512-yfORGUIPgLck41qyN7nbwJRAx17/jAIXCTanHOJZhB6PJ1iAk/84b/xlsVKFSyNyLXIj0dhppoE0+CRws7wlzA==} + + '@swc/core-darwin-arm64@1.7.26': + resolution: {integrity: sha512-FF3CRYTg6a7ZVW4yT9mesxoVVZTrcSWtmZhxKCYJX9brH4CS/7PRPjAKNk6kzWgWuRoglP7hkjQcd6EpMcZEAw==} + engines: {node: '>=10'} + cpu: [arm64] + os: [darwin] + + '@swc/core-darwin-x64@1.7.26': + resolution: {integrity: sha512-az3cibZdsay2HNKmc4bjf62QVukuiMRh5sfM5kHR/JMTrLyS6vSw7Ihs3UTkZjUxkLTT8ro54LI6sV6sUQUbLQ==} + engines: {node: '>=10'} + cpu: [x64] + os: [darwin] + + '@swc/core-linux-arm-gnueabihf@1.7.26': + resolution: {integrity: sha512-VYPFVJDO5zT5U3RpCdHE5v1gz4mmR8BfHecUZTmD2v1JeFY6fv9KArJUpjrHEEsjK/ucXkQFmJ0jaiWXmpOV9Q==} + engines: {node: '>=10'} + cpu: [arm] + os: [linux] + + '@swc/core-linux-arm64-gnu@1.7.26': + resolution: {integrity: sha512-YKevOV7abpjcAzXrhsl+W48Z9mZvgoVs2eP5nY+uoMAdP2b3GxC0Df1Co0I90o2lkzO4jYBpTMcZlmUXLdXn+Q==} + engines: {node: '>=10'} + cpu: [arm64] + os: [linux] + + '@swc/core-linux-arm64-musl@1.7.26': + resolution: {integrity: sha512-3w8iZICMkQQON0uIcvz7+Q1MPOW6hJ4O5ETjA0LSP/tuKqx30hIniCGOgPDnv3UTMruLUnQbtBwVCZTBKR3Rkg==} + engines: {node: '>=10'} + cpu: [arm64] + os: [linux] + + '@swc/core-linux-x64-gnu@1.7.26': + resolution: {integrity: sha512-c+pp9Zkk2lqb06bNGkR2Looxrs7FtGDMA4/aHjZcCqATgp348hOKH5WPvNLBl+yPrISuWjbKDVn3NgAvfvpH4w==} + engines: {node: '>=10'} + cpu: [x64] + os: [linux] + + '@swc/core-linux-x64-musl@1.7.26': + resolution: {integrity: sha512-PgtyfHBF6xG87dUSSdTJHwZ3/8vWZfNIXQV2GlwEpslrOkGqy+WaiiyE7Of7z9AvDILfBBBcJvJ/r8u980wAfQ==} + engines: {node: '>=10'} + cpu: [x64] + os: [linux] + + '@swc/core-win32-arm64-msvc@1.7.26': + resolution: {integrity: sha512-9TNXPIJqFynlAOrRD6tUQjMq7KApSklK3R/tXgIxc7Qx+lWu8hlDQ/kVPLpU7PWvMMwC/3hKBW+p5f+Tms1hmA==} + engines: {node: '>=10'} + cpu: [arm64] + os: [win32] + + '@swc/core-win32-ia32-msvc@1.7.26': + resolution: {integrity: sha512-9YngxNcG3177GYdsTum4V98Re+TlCeJEP4kEwEg9EagT5s3YejYdKwVAkAsJszzkXuyRDdnHUpYbTrPG6FiXrQ==} + engines: {node: '>=10'} + cpu: [ia32] + os: [win32] + + '@swc/core-win32-x64-msvc@1.7.26': + resolution: {integrity: sha512-VR+hzg9XqucgLjXxA13MtV5O3C0bK0ywtLIBw/+a+O+Oc6mxFWHtdUeXDbIi5AiPbn0fjgVJMqYnyjGyyX8u0w==} + engines: {node: '>=10'} + cpu: [x64] + os: [win32] + + '@swc/core@1.7.26': + resolution: {integrity: sha512-f5uYFf+TmMQyYIoxkn/evWhNGuUzC730dFwAKGwBVHHVoPyak1/GvJUm6i1SKl+2Hrj9oN0i3WSoWWZ4pgI8lw==} + engines: {node: '>=10'} + peerDependencies: + '@swc/helpers': '*' + peerDependenciesMeta: + '@swc/helpers': + optional: true + + '@swc/counter@0.1.3': + resolution: {integrity: sha512-e2BR4lsJkkRlKZ/qCHPw9ZaSxc0MVUd7gtbtaB7aMvHeJVYe8sOB8DBZkP2DtISHGSku9sCK6T6cnY0CtXrOCQ==} + + '@swc/types@0.1.12': + resolution: {integrity: sha512-wBJA+SdtkbFhHjTMYH+dEH1y4VpfGdAc2Kw/LK09i9bXd/K6j6PkDcFCEzb6iVfZMkPRrl/q0e3toqTAJdkIVA==} + + '@tenderly/hardhat-tenderly@2.3.0': + resolution: {integrity: sha512-Q21HeQofncnrH33Ys4Xd2HRgxl+4E/HgUqUIu6l734Cpw07KMwlsTicEML0nlVPgLDmtNrJv4cnFn4SypwioaA==} + peerDependencies: + ethers: ^6.8.1 + hardhat: ^2.22.6 + + '@trivago/prettier-plugin-sort-imports@3.4.0': + resolution: {integrity: sha512-485Iailw8X5f7KetzRka20RF1kPBEINR5LJMNwlBZWY1gRAlVnv5dZzyNPnLxSP0Qcia8HETa9Cdd8LlX9o+pg==} + peerDependencies: + prettier: 2.x + + '@tsconfig/node10@1.0.11': + resolution: {integrity: sha512-DcRjDCujK/kCk/cUe8Xz8ZSpm8mS3mNNpta+jGCA6USEDfktlNvm1+IuZ9eTcDbNk41BHwpHHeW+N1lKCz4zOw==} + + '@tsconfig/node12@1.0.11': + resolution: {integrity: sha512-cqefuRsh12pWyGsIoBKJA9luFu3mRxCA+ORZvA4ktLSzIuCUtWVxGIuXigEwO5/ywWFMZ2QEGKWvkZG1zDMTag==} + + '@tsconfig/node14@1.0.3': + resolution: {integrity: sha512-ysT8mhdixWK6Hw3i1V2AeRqZ5WfXg1G43mqoYlM2nc6388Fq5jcXyr5mRsqViLx/GJYdoL0bfXD8nmF+Zn/Iow==} + + '@tsconfig/node16@1.0.4': + resolution: {integrity: sha512-vxhUy4J8lyeyinH7Azl1pdd43GJhZH/tP2weN8TntQblOY+A0XbT8DJk1/oCPuOOyg/Ja757rG0CgHcWC8OfMA==} + + '@typechain/ethers-v6@0.5.1': + resolution: {integrity: sha512-F+GklO8jBWlsaVV+9oHaPh5NJdd6rAKN4tklGfInX1Q7h0xPgVLP39Jl3eCulPB5qexI71ZFHwbljx4ZXNfouA==} + peerDependencies: + ethers: 6.x + typechain: ^8.3.2 + typescript: '>=4.7.0' + + '@typechain/hardhat@9.1.0': + resolution: {integrity: sha512-mtaUlzLlkqTlfPwB3FORdejqBskSnh+Jl8AIJGjXNAQfRQ4ofHADPl1+oU7Z3pAJzmZbUXII8MhOLQltcHgKnA==} + peerDependencies: + '@typechain/ethers-v6': ^0.5.1 + ethers: ^6.1.0 + hardhat: ^2.9.9 + typechain: ^8.3.2 + + '@types/bn.js@4.11.6': + resolution: {integrity: sha512-pqr857jrp2kPuO9uRjZ3PwnJTjoQy+fcdxvBTvHm6dkmEL9q+hDD/2j/0ELOBPtPnS8LjCX0gI9nbl8lVkadpg==} + + '@types/bn.js@5.1.5': + resolution: {integrity: sha512-V46N0zwKRF5Q00AZ6hWtN0T8gGmDUaUzLWQvHFo5yThtVwK/VCenFY3wXVbOvNfajEpsTfQM4IN9k/d6gUVX3A==} + + '@types/chai-as-promised@7.1.8': + resolution: {integrity: sha512-ThlRVIJhr69FLlh6IctTXFkmhtP3NpMZ2QGq69StYLyKZFp/HOp1VdKZj7RvfNWYYcJ1xlbLGLLWj1UvP5u/Gw==} + + '@types/chai@4.3.19': + resolution: {integrity: sha512-2hHHvQBVE2FiSK4eN0Br6snX9MtolHaTo/batnLjlGRhoQzlCL61iVpxoqO7SfFyOw+P/pwv+0zNHzKoGWz9Cw==} + + '@types/concat-stream@1.6.1': + resolution: {integrity: sha512-eHE4cQPoj6ngxBZMvVf6Hw7Mh4jMW4U9lpGmS5GBPB9RYxlFg+CHaVN7ErNY4W9XfLIEn20b4VDYaIrbq0q4uA==} + + '@types/conventional-commits-parser@5.0.0': + resolution: {integrity: sha512-loB369iXNmAZglwWATL+WRe+CRMmmBPtpolYzIebFaX4YA3x+BEfLqhUAV9WanycKI3TG1IMr5bMJDajDKLlUQ==} + + '@types/estree@1.0.5': + resolution: {integrity: sha512-/kYRxGDLWzHOB7q+wtSUQlFrtcdUccpfy+X+9iMBpHK8QLLhx2wIPYuS5DYtR9Wa/YlZAbIovy7qVdB1Aq6Lyw==} + + '@types/form-data@0.0.33': + resolution: {integrity: sha512-8BSvG1kGm83cyJITQMZSulnl6QV8jqAGreJsc5tPu1Jq0vTSOiY/k24Wx82JRpWwZSqrala6sd5rWi6aNXvqcw==} + + '@types/glob@7.2.0': + resolution: {integrity: sha512-ZUxbzKl0IfJILTS6t7ip5fQQM/J3TJYubDm3nMbgubNNYS62eXeUpoLUC8/7fJNiFYHTrGPQn7hspDUzIHX3UA==} + + '@types/lru-cache@5.1.1': + resolution: {integrity: sha512-ssE3Vlrys7sdIzs5LOxCzTVMsU7i9oa/IaW92wF32JFb3CVczqOkru2xspuKczHEbG3nvmPY7IFqVmGGHdNbYw==} + + '@types/minimatch@5.1.2': + resolution: {integrity: sha512-K0VQKziLUWkVKiRVrx4a40iPaxTUefQmjtkQofBkYRcoaaL/8rhwDWww9qWbrgicNOgnpIsMxyNIUM4+n6dUIA==} + + '@types/minimist@1.2.5': + resolution: {integrity: sha512-hov8bUuiLiyFPGyFPE1lwWhmzYbirOXQNNo40+y3zow8aFVTeyn3VWL0VFFfdNddA8S4Vf0Tc062rzyNr7Paag==} + + '@types/mocha@10.0.7': + resolution: {integrity: sha512-GN8yJ1mNTcFcah/wKEFIJckJx9iJLoMSzWcfRRuxz/Jk+U6KQNnml+etbtxFK8lPjzOw3zp4Ha/kjSst9fsHYw==} + + '@types/node@10.17.60': + resolution: {integrity: sha512-F0KIgDJfy2nA3zMLmWGKxcH2ZVEtCZXHHdOQs2gSaQ27+lNeEfGxzkIw90aXswATX7AZ33tahPbzy6KAfUreVw==} + + '@types/node@18.15.13': + resolution: {integrity: sha512-N+0kuo9KgrUQ1Sn/ifDXsvg0TTleP7rIy4zOBGECxAljqvqfqpTfzx0Q1NUedOixRMBfe2Whhb056a42cWs26Q==} + + '@types/node@18.19.50': + resolution: {integrity: sha512-xonK+NRrMBRtkL1hVCc3G+uXtjh1Al4opBLjqVmipe5ZAaBYWW6cNAiBVZ1BvmkBhep698rP3UM3aRAdSALuhg==} + + '@types/node@20.5.1': + resolution: {integrity: sha512-4tT2UrL5LBqDwoed9wZ6N3umC4Yhz3W3FloMmiiG4JwmUJWpie0c7lcnUNd4gtMKuDEO4wRVS8B6Xa0uMRsMKg==} + + '@types/node@8.10.66': + resolution: {integrity: sha512-tktOkFUA4kXx2hhhrB8bIFb5TbwzS4uOhKEmwiD+NoiL0qtP2OQ9mFldbgD4dV1djrlBYP6eBuQZiWjuHUpqFw==} + + '@types/normalize-package-data@2.4.4': + resolution: {integrity: sha512-37i+OaWTh9qeK4LSHPsyRC7NahnGotNuZvjLSgcPzblpHB3rrCJxAOgI5gCdKm7coonsaX1Of0ILiTcnZjbfxA==} + + '@types/pbkdf2@3.1.2': + resolution: {integrity: sha512-uRwJqmiXmh9++aSu1VNEn3iIxWOhd8AHXNSdlaLfdAAdSTY9jYVeGWnzejM3dvrkbqE3/hyQkQQ29IFATEGlew==} + + '@types/prettier@2.7.3': + resolution: {integrity: sha512-+68kP9yzs4LMp7VNh8gdzMSPZFL44MLGqiHWvttYJe+6qnuVr4Ek9wSBQoveqY/r+LwjCcU29kNVkidwim+kYA==} + + '@types/qs@6.9.15': + resolution: {integrity: sha512-uXHQKES6DQKKCLh441Xv/dwxOq1TVS3JPUMlEqoEglvlhR6Mxnlew/Xq/LRVHpLyk7iK3zODe1qYHIMltO7XGg==} + + '@types/resolve@1.20.2': + resolution: {integrity: sha512-60BCwRFOZCQhDncwQdxxeOEEkbc5dIMccYLwbxsS4TUNeVECQ/pBJ0j09mrHOl/JJvpRPGwO9SvE4nR2Nb/a4Q==} + + '@types/secp256k1@4.0.6': + resolution: {integrity: sha512-hHxJU6PAEUn0TP4S/ZOzuTUvJWuZ6eIKeNKb5RBpODvSl6hp1Wrw4s7ATY50rklRCScUDpHzVA/DQdSjJ3UoYQ==} + + '@typescript-eslint/eslint-plugin@7.18.0': + resolution: {integrity: sha512-94EQTWZ40mzBc42ATNIBimBEDltSJ9RQHCC8vc/PDbxi4k8dVwUAv4o98dk50M1zB+JGFxp43FP7f8+FP8R6Sw==} + engines: {node: ^18.18.0 || >=20.0.0} + peerDependencies: + '@typescript-eslint/parser': ^7.0.0 + eslint: ^8.56.0 + typescript: '*' + peerDependenciesMeta: + typescript: + optional: true + + '@typescript-eslint/parser@7.18.0': + resolution: {integrity: sha512-4Z+L8I2OqhZV8qA132M4wNL30ypZGYOQVBfMgxDH/K5UX0PNqTu1c6za9ST5r9+tavvHiTWmBnKzpCJ/GlVFtg==} + engines: {node: ^18.18.0 || >=20.0.0} + peerDependencies: + eslint: ^8.56.0 + typescript: '*' + peerDependenciesMeta: + typescript: + optional: true + + '@typescript-eslint/scope-manager@7.18.0': + resolution: {integrity: sha512-jjhdIE/FPF2B7Z1uzc6i3oWKbGcHb87Qw7AWj6jmEqNOfDFbJWtjt/XfwCpvNkpGWlcJaog5vTR+VV8+w9JflA==} + engines: {node: ^18.18.0 || >=20.0.0} + + '@typescript-eslint/type-utils@7.18.0': + resolution: {integrity: sha512-XL0FJXuCLaDuX2sYqZUUSOJ2sG5/i1AAze+axqmLnSkNEVMVYLF+cbwlB2w8D1tinFuSikHmFta+P+HOofrLeA==} + engines: {node: ^18.18.0 || >=20.0.0} + peerDependencies: + eslint: ^8.56.0 + typescript: '*' + peerDependenciesMeta: + typescript: + optional: true + + '@typescript-eslint/types@7.18.0': + resolution: {integrity: sha512-iZqi+Ds1y4EDYUtlOOC+aUmxnE9xS/yCigkjA7XpTKV6nCBd3Hp/PRGGmdwnfkV2ThMyYldP1wRpm/id99spTQ==} + engines: {node: ^18.18.0 || >=20.0.0} + + '@typescript-eslint/typescript-estree@7.18.0': + resolution: {integrity: sha512-aP1v/BSPnnyhMHts8cf1qQ6Q1IFwwRvAQGRvBFkWlo3/lH29OXA3Pts+c10nxRxIBrDnoMqzhgdwVe5f2D6OzA==} + engines: {node: ^18.18.0 || >=20.0.0} + peerDependencies: + typescript: '*' + peerDependenciesMeta: + typescript: + optional: true + + '@typescript-eslint/utils@7.18.0': + resolution: {integrity: sha512-kK0/rNa2j74XuHVcoCZxdFBMF+aq/vH83CXAOHieC+2Gis4mF8jJXT5eAfyD3K0sAxtPuwxaIOIOvhwzVDt/kw==} + engines: {node: ^18.18.0 || >=20.0.0} + peerDependencies: + eslint: ^8.56.0 + + '@typescript-eslint/visitor-keys@7.18.0': + resolution: {integrity: sha512-cDF0/Gf81QpY3xYyJKDV14Zwdmid5+uuENhjH2EqFaF0ni+yAyq/LzMaIJdhNJXZI7uLzwIlA+V7oWoyn6Curg==} + engines: {node: ^18.18.0 || >=20.0.0} + + '@ungap/structured-clone@1.2.0': + resolution: {integrity: sha512-zuVdFrMJiuCDQUMCzQaD6KL28MjnqqN8XnAqiEq9PNm/hCPTSGfrXCOfwj1ow4LFb/tNymJPwsNbVePc1xFqrQ==} + + '@vue/compiler-core@3.5.4': + resolution: {integrity: sha512-oNwn+BAt3n9dK9uAYvI+XGlutwuTq/wfj4xCBaZCqwwVIGtD7D6ViihEbyYZrDHIHTDE3Q6oL3/hqmAyFEy9DQ==} + + '@vue/compiler-dom@3.5.4': + resolution: {integrity: sha512-yP9RRs4BDLOLfldn6ah+AGCNovGjMbL9uHvhDHf5wan4dAHLnFGOkqtfE7PPe4HTXIqE7l/NILdYw53bo1C8jw==} + + '@vue/compiler-sfc@3.5.4': + resolution: {integrity: sha512-P+yiPhL+NYH7m0ZgCq7AQR2q7OIE+mpAEgtkqEeH9oHSdIRvUO+4X6MPvblJIWcoe4YC5a2Gdf/RsoyP8FFiPQ==} + + '@vue/compiler-ssr@3.5.4': + resolution: {integrity: sha512-acESdTXsxPnYr2C4Blv0ggx5zIFMgOzZmYU2UgvIff9POdRGbRNBHRyzHAnizcItvpgerSKQbllUc9USp3V7eg==} + + '@vue/shared@3.5.4': + resolution: {integrity: sha512-L2MCDD8l7yC62Te5UUyPVpmexhL9ipVnYRw9CsWfm/BGRL5FwDX4a25bcJ/OJSD3+Hx+k/a8LDKcG2AFdJV3BA==} + + JSONStream@1.3.5: + resolution: {integrity: sha512-E+iruNOY8VV9s4JEbe1aNEm6MiszPRr/UfcHMz0TQh1BXSxHK+ASV1R6W4HpjBhSeS+54PIsAMCBmwD06LLsqQ==} + hasBin: true + + abbrev@1.0.9: + resolution: {integrity: sha512-LEyx4aLEC3x6T0UguF6YILf+ntvmOaWsVfENmIW0E9H09vKlLDGelMjjSm0jkDHALj8A8quZ/HapKNigzwge+Q==} + + abitype@0.9.10: + resolution: {integrity: sha512-FIS7U4n7qwAT58KibwYig5iFG4K61rbhAqaQh/UWj8v1Y8mjX3F8TC9gd8cz9yT1TYel9f8nS5NO5kZp2RW0jQ==} + peerDependencies: + typescript: '>=5.0.4' + zod: ^3 >=3.22.0 + peerDependenciesMeta: + typescript: + optional: true + zod: + optional: true + + abitype@1.0.5: + resolution: {integrity: sha512-YzDhti7cjlfaBhHutMaboYB21Ha3rXR9QTkNJFzYC4kC8YclaiwPBBBJY8ejFdu2wnJeZCVZSMlQJ7fi8S6hsw==} + peerDependencies: + typescript: '>=5.0.4' + zod: ^3 >=3.22.0 + peerDependenciesMeta: + typescript: + optional: true + zod: + optional: true + + acorn-jsx@5.3.2: + resolution: {integrity: sha512-rq9s+JNhf0IChjtDXxllJ7g41oZk5SlXtp0LHwyA5cejwn7vKmKp4pPri6YEePv2PU65sAsegbXtIinmDFDXgQ==} + peerDependencies: + acorn: ^6.0.0 || ^7.0.0 || ^8.0.0 + + acorn-walk@8.3.4: + resolution: {integrity: sha512-ueEepnujpqee2o5aIYnvHU6C0A42MNdsIDeqy5BydrkuC5R1ZuUFnm27EeFJGoEHJQgn3uleRvmTXaJgfXbt4g==} + engines: {node: '>=0.4.0'} + + acorn@8.12.1: + resolution: {integrity: sha512-tcpGyI9zbizT9JbV6oYE477V6mTlXvvi0T0G3SNIYE2apm/G5huBa1+K89VGeovbg+jycCrfhl3ADxErOuO6Jg==} + engines: {node: '>=0.4.0'} + hasBin: true + + adm-zip@0.4.16: + resolution: {integrity: sha512-TFi4HBKSGfIKsK5YCkKaaFG2m4PEDyViZmEwof3MTIgzimHLto6muaHVpbrljdIvIrFZzEq/p4nafOeLcYegrg==} + engines: {node: '>=0.3.0'} + + aes-js@3.0.0: + resolution: {integrity: sha512-H7wUZRn8WpTq9jocdxQ2c8x2sKo9ZVmzfRE13GiNJXfp7NcKYEdvl3vspKjXox6RIG2VtaRe4JFvxG4rqp2Zuw==} + + aes-js@4.0.0-beta.5: + resolution: {integrity: sha512-G965FqalsNyrPqgEGON7nIx1e/OVENSgiEIzyC63haUMuvNnwIgIjMs52hlTCKhkBny7A2ORNlfY9Zu+jmGk1Q==} + + agent-base@6.0.2: + resolution: {integrity: sha512-RZNwNclF7+MS/8bDg70amg32dyeZGZxiDuQmZxKLAlQjr3jGyLx+4Kkk58UO7D2QdgFIQCovuSuZESne6RG6XQ==} + engines: {node: '>= 6.0.0'} + + aggregate-error@3.1.0: + resolution: {integrity: sha512-4I7Td01quW/RpocfNayFdFVk1qSuoh0E7JrbRJ16nH01HhKFQ88INq9Sd+nd72zqRySlr9BmDA8xlEJ6vJMrYA==} + engines: {node: '>=8'} + + ajv@6.12.6: + resolution: {integrity: sha512-j3fVLgvTo527anyYyJOGTYJbG+vnnQYvE0m5mmkc1TK+nxAppkCLMIL0aZ4dblVCNoGShhm+kzE4ZUykBoMg4g==} + + ajv@8.17.1: + resolution: {integrity: sha512-B/gBuNg5SiMTrPkC+A2+cW0RszwxYmn6VYxB/inlBStS5nx6xHIt/ehKRhIMhqusl7a8LjQoZnjCs5vhwxOQ1g==} + + amazon-cognito-identity-js@6.3.12: + resolution: {integrity: sha512-s7NKDZgx336cp+oDeUtB2ZzT8jWJp/v2LWuYl+LQtMEODe22RF1IJ4nRiDATp+rp1pTffCZcm44Quw4jx2bqNg==} + + amdefine@1.0.1: + resolution: {integrity: sha512-S2Hw0TtNkMJhIabBwIojKL9YHO5T0n5eNqWJ7Lrlel/zDbftQpxpapi8tZs3X1HWa+u+QeydGmzzNU0m09+Rcg==} + engines: {node: '>=0.4.2'} + + ansi-align@3.0.1: + resolution: {integrity: sha512-IOfwwBF5iczOjp/WeY4YxyjqAFMQoZufdQWDd19SEExbVLNXqvpzSJ/M7Za4/sCPmQ0+GRquoA7bGcINcxew6w==} + + ansi-colors@4.1.3: + resolution: {integrity: sha512-/6w/C21Pm1A7aZitlI5Ni/2J6FFQN8i1Cvz3kHABAAbw93v/NlvKdVOqz7CCWz/3iv/JplRSEEZ83XION15ovw==} + engines: {node: '>=6'} + + ansi-escapes@4.3.2: + resolution: {integrity: sha512-gKXj5ALrKWQLsYG9jlTRmR/xKluxHV+Z9QEwNIgCfM1/uwPMCuzVVnh5mwTd+OuBZcwSIMbqssNWRm1lE51QaQ==} + engines: {node: '>=8'} + + ansi-escapes@5.0.0: + resolution: {integrity: sha512-5GFMVX8HqE/TB+FuBJGuO5XG0WrsA6ptUqoODaT/n9mmUaZFkqnBueB4leqGBCmrUHnCnC4PCZTCd0E7QQ83bA==} + engines: {node: '>=12'} + + ansi-regex@3.0.1: + resolution: {integrity: sha512-+O9Jct8wf++lXxxFc4hc8LsjaSq0HFzzL7cVsw8pRDIPdjKD2mT4ytDZlLuSBZ4cLKZFXIrMGO7DbQCtMJJMKw==} + engines: {node: '>=4'} + + ansi-regex@5.0.1: + resolution: {integrity: sha512-quJQXlTSUGL2LH9SUXo8VwsY4soanhgo6LNSm84E1LBcE8s3O0wpdiRzyR9z/ZZJMlMWv37qOOb9pdJlMUEKFQ==} + engines: {node: '>=8'} + + ansi-regex@6.1.0: + resolution: {integrity: sha512-7HSX4QQb4CspciLpVFwyRe79O3xsIZDDLER21kERQ71oaPodF8jL725AgJMFAYbooIqolJoRLuM81SpeUkpkvA==} + engines: {node: '>=12'} + + ansi-styles@3.2.1: + resolution: {integrity: sha512-VT0ZI6kZRdTh8YyJw3SMbYm/u+NqfsAxEpWO0Pf9sq8/e94WxxOpPKx9FR1FlyCtOVDNOQ+8ntlqFxiRc+r5qA==} + engines: {node: '>=4'} + + ansi-styles@4.3.0: + resolution: {integrity: sha512-zbB9rCJAT1rbjiVDb2hqKFHNYLxgtk8NURxZ3IZwD3F6NtxbXZQCnnSi1Lkx+IDohdPlFp222wVALIheZJQSEg==} + engines: {node: '>=8'} + + ansi-styles@6.2.1: + resolution: {integrity: sha512-bN798gFfQX+viw3R7yrGWRqnrN2oRkEkUjjl4JNn4E8GxxbjtG3FbrEIIY3l8/hrwUwIeCZvi4QuOTP4MErVug==} + engines: {node: '>=12'} + + antlr4@4.13.2: + resolution: {integrity: sha512-QiVbZhyy4xAZ17UPEuG3YTOt8ZaoeOR1CvEAqrEsDBsOqINslaB147i9xqljZqoyf5S+EUlGStaj+t22LT9MOg==} + engines: {node: '>=16'} + + antlr4ts@0.5.0-alpha.4: + resolution: {integrity: sha512-WPQDt1B74OfPv/IMS2ekXAKkTZIHl88uMetg6q3OTqgFxZ/dxDXI0EWLyZid/1Pe6hTftyg5N7gel5wNAGxXyQ==} + + anymatch@3.1.3: + resolution: {integrity: sha512-KMReFUr0B4t+D+OBkjR3KYqvocp2XaSzO55UcB6mgQMd3KbcE+mWTyvVV7D/zsdEbNnV6acZUutkiHQXvTr1Rw==} + engines: {node: '>= 8'} + + arg@4.1.3: + resolution: {integrity: sha512-58S9QDqG0Xx27YwPSt9fJxivjYl432YCwfDMfZ+71RAqUrZef7LrKQZ3LHLOwCS4FLNBplP533Zx895SeOCHvA==} + + argparse@1.0.10: + resolution: {integrity: sha512-o5Roy6tNG4SL/FOkCAN6RzjiakZS25RLYFrcMttJqbdd8BWrnA+fGz57iN5Pb06pvBGvl5gQ0B48dJlslXvoTg==} + + argparse@2.0.1: + resolution: {integrity: sha512-8+9WqebbFzpX9OR+Wa6O29asIogeRMzcGtAINdpMHHyAg10f05aSFVBbcEqGf/PXw1EjAZ+q2/bEBg3DvurK3Q==} + + array-back@3.1.0: + resolution: {integrity: sha512-TkuxA4UCOvxuDK6NZYXCalszEzj+TLszyASooky+i742l9TqsOdYCMJJupxRic61hwquNtppB3hgcuq9SVSH1Q==} + engines: {node: '>=6'} + + array-back@4.0.2: + resolution: {integrity: sha512-NbdMezxqf94cnNfWLL7V/im0Ub+Anbb0IoZhvzie8+4HJ4nMQuzHuy49FkGYCJK2yAloZ3meiB6AVMClbrI1vg==} + engines: {node: '>=8'} + + array-ify@1.0.0: + resolution: {integrity: sha512-c5AMf34bKdvPhQ7tBGhqkgKNUzMr4WUs+WDtC2ZUGOUncbxKMTvqxYctiseW3+L4bA8ec+GcZ6/A/FW4m8ukng==} + + array-union@2.1.0: + resolution: {integrity: sha512-HGyxoOTYUyCM6stUe6EJgnd4EoewAI7zMdfqO+kGjnlZmBDz/cR5pf8r/cR4Wq60sL/p0IkcjUEEPwS3GFrIyw==} + engines: {node: '>=8'} + + array-uniq@1.0.3: + resolution: {integrity: sha512-MNha4BWQ6JbwhFhj03YK552f7cb3AzoE8SzeljgChvL1dl3IcvggXVz1DilzySZkCja+CXuZbdW7yATchWn8/Q==} + engines: {node: '>=0.10.0'} + + arrify@1.0.1: + resolution: {integrity: sha512-3CYzex9M9FGQjCGMGyi6/31c8GJbgb0qGyrx5HWxPd0aCwh4cB2YjMb2Xf9UuoogrMrlO9cTqnB5rI5GHZTcUA==} + engines: {node: '>=0.10.0'} + + asap@2.0.6: + resolution: {integrity: sha512-BSHWgDSAiKs50o2Re8ppvp3seVHXSRM44cdSsT9FfNEUUZLOGWVCsiWaRPWM1Znn+mqZ1OfVZ3z3DWEzSp7hRA==} + + assertion-error@1.1.0: + resolution: {integrity: sha512-jgsaNduz+ndvGyFt3uSuWqvy4lCnIJiovtouQN5JZHOKCS2QuhEdbcQHFhVksz2N2U9hXJo8odG7ETyWlEeuDw==} + + ast-parents@0.0.1: + resolution: {integrity: sha512-XHusKxKz3zoYk1ic8Un640joHbFMhbqneyoZfoKnEGtf2ey9Uh/IdpcQplODdO/kENaMIWsD0nJm4+wX3UNLHA==} + + astral-regex@2.0.0: + resolution: {integrity: sha512-Z7tMw1ytTXt5jqMcOP+OQteU1VuNK9Y02uuJtKQ1Sv69jXQKKg5cibLwGJow8yzZP+eAc18EmLGPal0bp36rvQ==} + engines: {node: '>=8'} + + async-retry@1.3.3: + resolution: {integrity: sha512-wfr/jstw9xNi/0teMHrRW7dsz3Lt5ARhYNZ2ewpadnhaIp5mbALhOAP+EAdsC7t4Z6wqsDVv9+W6gm1Dk9mEyw==} + + async@1.5.2: + resolution: {integrity: sha512-nSVgobk4rv61R9PUSDtYt7mPVB2olxNR5RWJcAsH676/ef11bUZwvu7+RGYrYauVdDPcO519v68wRhXQtxsV9w==} + + asynckit@0.4.0: + resolution: {integrity: sha512-Oei9OH4tRh0YqU3GxhX79dM/mwVgvbZJaSNaRk+bshkj0S5cfHcgYakreBjrHwatXKbz+IoIdYLxrKim2MjW0Q==} + + at-least-node@1.0.0: + resolution: {integrity: sha512-+q/t7Ekv1EDY2l6Gda6LLiX14rU9TV20Wa3ofeQmwPFZbOMo9DXrLbOjFaaclkXKWidIaopwAObQDqwWtGUjqg==} + engines: {node: '>= 4.0.0'} + + axios@0.21.4: + resolution: {integrity: sha512-ut5vewkiu8jjGBdqpM44XxjuCjq9LAKeHVmoVfHVzy8eHgxxq8SbAVQNovDA8mVi05kP0Ea/n/UzcSHcTJQfNg==} + + axios@0.27.2: + resolution: {integrity: sha512-t+yRIyySRTp/wua5xEr+z1q60QmLq8ABsS5O9Me1AsE5dfKqgnCFzwiCZZ/cGNd1lq4/7akDWMxdhVlucjmnOQ==} + + axios@1.7.7: + resolution: {integrity: sha512-S4kL7XrjgBmvdGut0sN3yJxqYzrDOnivkBiN0OFs6hLiUam3UPvswUo0kqGyhqUZGEOytHyumEdXsAkgCOUf3Q==} + + balanced-match@1.0.2: + resolution: {integrity: sha512-3oSeUO0TMV67hN1AmbXsK4yaqU7tjiHlbxRDZOpH0KW9+CeX4bRAaX0Anxt0tx2MrpRpWwQaPwIlISEJhYU5Pw==} + + base-x@3.0.10: + resolution: {integrity: sha512-7d0s06rR9rYaIWHkpfLIFICM/tkSVdoPC9qYAQRpxn9DdKNWNsKC0uk++akckyLq16Tx2WIinnZ6WRriAt6njQ==} + + base64-js@1.5.1: + resolution: {integrity: sha512-AKpaYlHn8t4SVbOHCy+b5+KKgvR4vrsD8vbvrbiQJps7fKDTkjkDry6ji0rUJjC0kzbNePLwzxq8iypo41qeWA==} + + bech32@1.1.4: + resolution: {integrity: sha512-s0IrSOzLlbvX7yp4WBfPITzpAU8sqQcpsmwXDiKwrG4r491vwCO/XpejasRNl0piBMe/DvP4Tz0mIS/X1DPJBQ==} + + binary-extensions@2.3.0: + resolution: {integrity: sha512-Ceh+7ox5qe7LJuLHoY0feh3pHuUDHAcRUeyL2VYghZwfpkNIy/+8Ocg0a3UuSoYzavmylwuLWQOf3hl0jjMMIw==} + engines: {node: '>=8'} + + bl@4.1.0: + resolution: {integrity: sha512-1W07cM9gS6DcLperZfFSj+bWLtaPGSOHWhPiGzXmvVJbRLdG82sH/Kn8EtW1VqWVA54AKf2h5k5BbnIbwF3h6w==} + + blakejs@1.2.1: + resolution: {integrity: sha512-QXUSXI3QVc/gJME0dBpXrag1kbzOqCjCX8/b54ntNyW6sjtoqxqRk3LTmXzaJoh71zMsDCjM+47jS7XiwN/+fQ==} + + bn.js@4.11.6: + resolution: {integrity: sha512-XWwnNNFCuuSQ0m3r3C4LE3EiORltHd9M05pq6FOlVeiophzRbMo50Sbz1ehl8K3Z+jw9+vmgnXefY1hz8X+2wA==} + + bn.js@4.12.0: + resolution: {integrity: sha512-c98Bf3tPniI+scsdk237ku1Dc3ujXQTSgyiPUDEOe7tRkhrqridvh8klBv0HCEso1OLOYcHuCv/cS6DNxKH+ZA==} + + bn.js@5.2.1: + resolution: {integrity: sha512-eXRvHzWyYPBuB4NBy0cmYQjGitUrtqwbvlzP3G6VFnNRbsZQIxQ10PbKKHt8gZ/HW/D/747aDl+QkDqg3KQLMQ==} + + boxen@5.1.2: + resolution: {integrity: sha512-9gYgQKXx+1nP8mP7CzFyaUARhg7D3n1dF/FnErWmu9l6JvGpNUN278h0aSb+QjoiKSWG+iZ3uHrcqk0qrY9RQQ==} + engines: {node: '>=10'} + + brace-expansion@1.1.11: + resolution: {integrity: sha512-iCuPHDFgrHX7H2vEI/5xpz07zSHB00TpugqhmYtVmMO6518mCuRMoOYFldEBl0g187ufozdaHgWKcYFb61qGiA==} + + brace-expansion@2.0.1: + resolution: {integrity: sha512-XnAIvQ8eM+kC6aULx6wuQiwVsnzsi9d3WxzV3FpWTGA19F621kwdbsAcFKXgKUHZWsy+mY6iL1sHTxWEFCytDA==} + + braces@3.0.3: + resolution: {integrity: sha512-yQbXgO/OSZVD2IsiLlro+7Hf6Q18EJrKSEsdoMzKePKXct3gvD8oLcOQdIzGupr5Fj+EDe8gO/lxc1BzfMpxvA==} + engines: {node: '>=8'} + + brorand@1.1.0: + resolution: {integrity: sha512-cKV8tMCEpQs4hK/ik71d6LrPOnpkpGBR0wzxqr68g2m/LB2GxVYQroAjMJZRVM1Y4BCjCKc3vAamxSzOY2RP+w==} + + browser-stdout@1.3.1: + resolution: {integrity: sha512-qhAVI1+Av2X7qelOfAIYwXONood6XlZE/fXaBSmW/T5SzLAmCgzi+eiWE7fUvbHaeNBQH13UftjpXxsfLkMpgw==} + + browserify-aes@1.2.0: + resolution: {integrity: sha512-+7CHXqGuspUn/Sl5aO7Ea0xWGAtETPXNSAjHo48JfLdPWcMng33Xe4znFvQweqc/uzk5zSOI3H52CYnjCfb5hA==} + + browserslist@4.23.3: + resolution: {integrity: sha512-btwCFJVjI4YWDNfau8RhZ+B1Q/VLoUITrm3RlP6y1tYGWIOa+InuYiRGXUBXo8nA1qKmHMyLB/iVQg5TT4eFoA==} + engines: {node: ^6 || ^7 || ^8 || ^9 || ^10 || ^11 || ^12 || >=13.7} + hasBin: true + + bs58@4.0.1: + resolution: {integrity: sha512-Ok3Wdf5vOIlBrgCvTq96gBkJw+JUEzdBgyaza5HLtPm7yTHkjRy8+JzNyHF7BHa0bNWOQIp3m5YF0nnFcOIKLw==} + + bs58check@2.1.2: + resolution: {integrity: sha512-0TS1jicxdU09dwJMNZtVAfzPi6Q6QeN0pM1Fkzrjn+XYHvzMKPU3pHVpva+769iNVSfIYWf7LJ6WR+BuuMf8cA==} + + buffer-from@1.1.2: + resolution: {integrity: sha512-E+XQCRwSbaaiChtv6k6Dwgc+bx+Bs6vuKJHHl5kox/BaKbhiXzqQOwK4cO22yElGp2OCmjwVhT3HmxgyPGnJfQ==} + + buffer-xor@1.0.3: + resolution: {integrity: sha512-571s0T7nZWK6vB67HI5dyUF7wXiNcfaPPPTl6zYCNApANjIvYJTg7hlud/+cJpdAhS7dVzqMLmfhfHR3rAcOjQ==} + + buffer@4.9.2: + resolution: {integrity: sha512-xq+q3SRMOxGivLhBNaUdC64hDTQwejJ+H0T/NB1XMtTVEwNTrfFF3gAxiyW0Bu/xWEGhjVKgUcMhCrUy2+uCWg==} + + buffer@5.7.1: + resolution: {integrity: sha512-EHcyIPBQ4BSGlvjB16k5KgAJ27CIsHY/2JBmCRReo48y9rQ3MaUzWX3KVlBa4U7MyX02HdVj0K7C3WaB3ju7FQ==} + + bufio@1.2.1: + resolution: {integrity: sha512-9oR3zNdupcg/Ge2sSHQF3GX+kmvL/fTPvD0nd5AGLq8SjUYnTz+SlFjK/GXidndbZtIj+pVKXiWeR9w6e9wKCA==} + engines: {node: '>=14.0.0'} + + builtin-modules@3.3.0: + resolution: {integrity: sha512-zhaCDicdLuWN5UbN5IMnFqNMhNfo919sH85y2/ea+5Yg9TsTkeZxpL+JLbp6cgYFS4sRLp3YV4S6yDuqVWHYOw==} + engines: {node: '>=6'} + + builtins@2.0.1: + resolution: {integrity: sha512-XkkVe5QAb6guWPXTzpSrYpSlN3nqEmrrE2TkAr/tp7idSF6+MONh9WvKrAuR3HiKLvoSgmbs8l1U9IPmMrIoLw==} + + bytes@3.1.2: + resolution: {integrity: sha512-/Nf7TyzTx6S3yRJObOAV7956r8cr2+Oj8AC5dt8wSP3BQAoeX58NoHyCU8P8zGkNXStjTSi6fzO6F0pBdcYbEg==} + engines: {node: '>= 0.8'} + + cachedir@2.3.0: + resolution: {integrity: sha512-A+Fezp4zxnit6FanDmv9EqXNAi3vt9DWp51/71UEhXukb7QUuvtv9344h91dyAxuTLoSYJFU299qzR3tzwPAhw==} + engines: {node: '>=6'} + + call-bind@1.0.7: + resolution: {integrity: sha512-GHTSNSYICQ7scH7sZ+M2rFopRoLh8t2bLSW6BbgrtLsahOIB5iyAVJf9GjWK3cYTDaMj4XdBpM1cA6pIS0Kv2w==} + engines: {node: '>= 0.4'} + + callsites@3.1.0: + resolution: {integrity: sha512-P8BjAsXvZS+VIDUI11hHCQEv74YT67YUi5JJFNWIqL235sBmjX4+qx9Muvls5ivyNENctx46xQLQ3aTuE7ssaQ==} + engines: {node: '>=6'} + + camelcase-keys@6.2.2: + resolution: {integrity: sha512-YrwaA0vEKazPBkn0ipTiMpSajYDSe+KjQfrjhcBMxJt/znbvlHd8Pw/Vamaz5EB4Wfhs3SUR3Z9mwRu/P3s3Yg==} + engines: {node: '>=8'} + + camelcase@5.3.1: + resolution: {integrity: sha512-L28STB170nwWS63UjtlEOE3dldQApaJXZkOI1uMFfzf3rRuPegHaHesyee+YxQ+W6SvRDQV6UrdOdRiR153wJg==} + engines: {node: '>=6'} + + camelcase@6.3.0: + resolution: {integrity: sha512-Gmy6FhYlCY7uOElZUSbxo2UCDH8owEk996gkbrpsgGtrJLM3J7jGxl9Ic7Qwwj4ivOE5AWZWRMecDdF7hqGjFA==} + engines: {node: '>=10'} + + caniuse-lite@1.0.30001660: + resolution: {integrity: sha512-GacvNTTuATm26qC74pt+ad1fW15mlQ/zuTzzY1ZoIzECTP8HURDfF43kNxPgf7H1jmelCBQTTbBNxdSXOA7Bqg==} + + caseless@0.12.0: + resolution: {integrity: sha512-4tYFyifaFfGacoiObjJegolkwSU4xQNGbVgUiNYVUxbQ2x2lUsFvY4hVgVzGiIe6WLOPqycWXA40l+PWsxthUw==} + + cbor@8.1.0: + resolution: {integrity: sha512-DwGjNW9omn6EwP70aXsn7FQJx5kO12tX0bZkaTjzdVFM6/7nhA4t0EENocKGx6D2Bch9PE2KzCUf5SceBdeijg==} + engines: {node: '>=12.19'} + + cbor@9.0.2: + resolution: {integrity: sha512-JPypkxsB10s9QOWwa6zwPzqE1Md3vqpPc+cai4sAecuCsRyAtAl/pMyhPlMbT/xtPnm2dznJZYRLui57qiRhaQ==} + engines: {node: '>=16'} + + chai-as-promised@7.1.2: + resolution: {integrity: sha512-aBDHZxRzYnUYuIAIPBH2s511DjlKPzXNlXSGFC8CwmroWQLfrW0LtE1nK3MAwwNhJPa9raEjNCmRoFpG0Hurdw==} + peerDependencies: + chai: '>= 2.1.2 < 6' + + chai@4.5.0: + resolution: {integrity: sha512-RITGBfijLkBddZvnn8jdqoTypxvqbOLYQkGGxXzeFjVHvudaPw0HNFD9x928/eUwYWd2dPCugVqspGALTZZQKw==} + engines: {node: '>=4'} + + chalk@2.4.2: + resolution: {integrity: sha512-Mti+f9lpJNcwF4tWV8/OrTTtF1gZi+f8FqlyAdouralcFWFQWF2+NgCHShjkCb+IFBLq9buZwE1xckQU4peSuQ==} + engines: {node: '>=4'} + + chalk@4.1.2: + resolution: {integrity: sha512-oKnbhFyRIXpUuez8iBMmyEa4nbj4IOQyuhc/wy9kY7/WVPcwIO9VA668Pu8RkO7+0G76SLROeyw9CpQ061i4mA==} + engines: {node: '>=10'} + + chalk@5.3.0: + resolution: {integrity: sha512-dLitG79d+GV1Nb/VYcCDFivJeK1hiukt9QjRNVOsUtTy1rR1YJsmpGGTZ3qJos+uw7WmWF4wUwBd9jxjocFC2w==} + engines: {node: ^12.17.0 || ^14.13 || >=16.0.0} + + chardet@0.7.0: + resolution: {integrity: sha512-mT8iDcrh03qDGRRmoA2hmBJnxpllMR+0/0qlzjqZES6NdiWDcZkCNAk4rPFZ9Q85r27unkiNNg8ZOiwZXBHwcA==} + + charenc@0.0.2: + resolution: {integrity: sha512-yrLQ/yVUFXkzg7EDQsPieE/53+0RlaWTs+wBrvW36cyilJ2SaDWfl4Yj7MtLTXleV9uEKefbAGUPv2/iWSooRA==} + + check-error@1.0.3: + resolution: {integrity: sha512-iKEoDYaRmd1mxM90a2OEfWhjsjPpYPuQ+lMYsoxB126+t8fw7ySEO48nmDg5COTjxDI65/Y2OWpeEHk3ZOe8zg==} + + chokidar@3.6.0: + resolution: {integrity: sha512-7VT13fmjotKpGipCW9JEQAusEPE+Ei8nl6/g4FBAmIm0GOOLMua9NDDo/DWp0ZAxCr3cPq5ZpBqmPAQgDda2Pw==} + engines: {node: '>= 8.10.0'} + + ci-info@2.0.0: + resolution: {integrity: sha512-5tK7EtrZ0N+OLFMthtqOj4fI2Jeb88C4CAZPu25LDVUgXJ0A3Js4PMGqrn0JU1W0Mh1/Z8wZzYPxqUrXeBboCQ==} + + cipher-base@1.0.4: + resolution: {integrity: sha512-Kkht5ye6ZGmwv40uUDZztayT2ThLQGfnj/T71N/XzeZeo3nf8foyW7zGTsPYkEya3m5f3cAypH+qe7YOrM1U2Q==} + + clean-stack@2.2.0: + resolution: {integrity: sha512-4diC9HaTE+KRAMWhDhrGOECgWZxoevMc5TlkObMqNSsVU62PYzXZ/SMTjzyGAFF1YusgxGcSWTEXBhp0CPwQ1A==} + engines: {node: '>=6'} + + cli-boxes@2.2.1: + resolution: {integrity: sha512-y4coMcylgSCdVinjiDBuR8PCC2bLjyGTwEmPb9NHR/QaNU6EUOXcTY/s6VjGMD6ENSEaeQYHCY0GNGS5jfMwPw==} + engines: {node: '>=6'} + + cli-cursor@3.1.0: + resolution: {integrity: sha512-I/zHAwsKf9FqGoXM4WWRACob9+SNukZTd94DWF57E4toouRulbCxcUh6RKUEOQlYTHJnzkPMySvPNaaSLNfLZw==} + engines: {node: '>=8'} + + cli-cursor@4.0.0: + resolution: {integrity: sha512-VGtlMu3x/4DOtIUwEkRezxUZ2lBacNJCHash0N0WeZDBS+7Ux1dm3XWAgWYxLJFMMdOeXMHXorshEFhbMSGelg==} + engines: {node: ^12.20.0 || ^14.13.1 || >=16.0.0} + + cli-spinners@2.9.2: + resolution: {integrity: sha512-ywqV+5MmyL4E7ybXgKys4DugZbX0FC6LnwrhjuykIjnK9k8OQacQ7axGKnjDXWNhns0xot3bZI5h55H8yo9cJg==} + engines: {node: '>=6'} + + cli-table3@0.5.1: + resolution: {integrity: sha512-7Qg2Jrep1S/+Q3EceiZtQcDPWxhAvBw+ERf1162v4sikJrvojMHFqXt8QIVha8UlH9rgU0BeWPytZ9/TzYqlUw==} + engines: {node: '>=6'} + + cli-table3@0.6.5: + resolution: {integrity: sha512-+W/5efTR7y5HRD7gACw9yQjqMVvEMLBHmboM/kPWam+H+Hmyrgjh6YncVKK122YZkXrLudzTuAukUw9FnMf7IQ==} + engines: {node: 10.* || >= 12.*} + + cli-truncate@3.1.0: + resolution: {integrity: sha512-wfOBkjXteqSnI59oPcJkcPl/ZmwvMMOj340qUIY1SKZCv0B9Cf4D4fAucRkIKQmsIuYK3x1rrgU7MeGRruiuiA==} + engines: {node: ^12.20.0 || ^14.13.1 || >=16.0.0} + + cli-width@3.0.0: + resolution: {integrity: sha512-FxqpkPPwu1HjuN93Omfm4h8uIanXofW0RxVEW3k5RKx+mJJYSthzNhp32Kzxxy3YAEZ/Dc/EWN1vZRY0+kOhbw==} + engines: {node: '>= 10'} + + cliui@7.0.4: + resolution: {integrity: sha512-OcRE68cOsVMXp1Yvonl/fzkQOyjLSu/8bhPDfQt0e0/Eb283TKP20Fs2MqoPsr9SwA595rRCA+QMzYc9nBP+JQ==} + + cliui@8.0.1: + resolution: {integrity: sha512-BSeNnyus75C4//NQ9gQt1/csTXyo/8Sb+afLAkzAptFuMsod9HFokGNudZpi/oQV73hnVK+sR+5PVRMd+Dr7YQ==} + engines: {node: '>=12'} + + clone@1.0.4: + resolution: {integrity: sha512-JQHZ2QMW6l3aH/j6xCqQThY/9OH4D/9ls34cgkUBiEeocRTU04tHfKPBsUK1PqZCUQM7GiA0IIXJSuXHI64Kbg==} + engines: {node: '>=0.8'} + + color-convert@1.9.3: + resolution: {integrity: sha512-QfAUtd+vFdAtFQcC8CCyYt1fYWxSqAiK2cSD6zDB8N3cpsEBAvRxp9zOGg6G/SHHJYAT88/az/IuDGALsNVbGg==} + + color-convert@2.0.1: + resolution: {integrity: sha512-RRECPsj7iu/xb5oKYcsFHSppFNnsj/52OVTRKb4zP5onXwVF3zVmmToNcOfGC+CRDpfK/U584fMg38ZHCaElKQ==} + engines: {node: '>=7.0.0'} + + color-name@1.1.3: + resolution: {integrity: sha512-72fSenhMw2HZMTVHeCA9KCmpEIbzWiQsjN+BHcBbS9vr1mtt+vJjPdksIBNUmKAW8TFUDPJK5SUU3QhE9NEXDw==} + + color-name@1.1.4: + resolution: {integrity: sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA==} + + colorette@2.0.20: + resolution: {integrity: sha512-IfEDxwoWIjkeXL1eXcDiow4UbKjhLdq6/EuSVR9GMN7KVH3r9gQ83e73hsz1Nd1T3ijd5xv1wcWRYO+D6kCI2w==} + + colors@1.4.0: + resolution: {integrity: sha512-a+UqTh4kgZg/SlGvfbzDHpgRu7AAQOmmqRHJnxhRZICKFUT91brVhNNt58CMWU9PsBbv3PDCZUHbVxuDiH2mtA==} + engines: {node: '>=0.1.90'} + + combined-stream@1.0.8: + resolution: {integrity: sha512-FQN4MRfuJeHf7cBbBMJFXhKSDq+2kAArBlmRBvcvFE5BB1HZKXtSFASDhdlz9zOYwxh8lDdnvmMOe/+5cdoEdg==} + engines: {node: '>= 0.8'} + + command-exists@1.2.9: + resolution: {integrity: sha512-LTQ/SGc+s0Xc0Fu5WaKnR0YiygZkm9eKFvyS+fRsU7/ZWFF8ykFM6Pc9aCVf1+xasOOZpO3BAVgVrKvsqKHV7w==} + + command-line-args@5.2.1: + resolution: {integrity: sha512-H4UfQhZyakIjC74I9d34fGYDwk3XpSr17QhEd0Q3I9Xq1CETHo4Hcuo87WyWHpAF1aSLjLRf5lD9ZGX2qStUvg==} + engines: {node: '>=4.0.0'} + + command-line-usage@6.1.3: + resolution: {integrity: sha512-sH5ZSPr+7UStsloltmDh7Ce5fb8XPlHyoPzTpyyMuYCtervL65+ubVZ6Q61cFtFl62UyJlc8/JwERRbAFPUqgw==} + engines: {node: '>=8.0.0'} + + commander@10.0.1: + resolution: {integrity: sha512-y4Mg2tXshplEbSGzx7amzPwKKOCGuoSRP/CjEdwwk0FOGlUbq6lKuoyDZTNZkmxHdJtp54hdfY/JUrdL7Xfdug==} + engines: {node: '>=14'} + + commander@11.0.0: + resolution: {integrity: sha512-9HMlXtt/BNoYr8ooyjjNRdIilOTkVJXB+GhxMTtOKwk0R4j4lS4NpjuqmRxroBfnfTSHQIHQB7wryHhXarNjmQ==} + engines: {node: '>=16'} + + commander@8.3.0: + resolution: {integrity: sha512-OkTL9umf+He2DZkUq8f8J9of7yL6RJKI24dVITBmNfZBmri9zYZQrKkuXiKhyfPSu8tUhnVBB1iKXevvnlR4Ww==} + engines: {node: '>= 12'} + + commander@9.5.0: + resolution: {integrity: sha512-KRs7WVDKg86PWiuAqhDrAQnTXZKraVcCc6vFdL14qrZ/DcWwuRo7VoiYXalXO7S5GKpqYiVEwCbgFDfxNHKJBQ==} + engines: {node: ^12.20.0 || >=14} + + commitizen@4.3.0: + resolution: {integrity: sha512-H0iNtClNEhT0fotHvGV3E9tDejDeS04sN1veIebsKYGMuGscFaswRoYJKmT3eW85eIJAs0F28bG2+a/9wCOfPw==} + engines: {node: '>= 12'} + hasBin: true + + commondir@1.0.1: + resolution: {integrity: sha512-W9pAhw0ja1Edb5GVdIF1mjZw/ASI0AlShXM83UUGe2DVr5TdAPEA1OA8m/g8zWp9x6On7gqufY+FatDbC3MDQg==} + + compare-func@2.0.0: + resolution: {integrity: sha512-zHig5N+tPWARooBnb0Zx1MFcdfpyJrfTJ3Y5L+IFvUm8rM74hHz66z0gw0x4tijh5CorKkKUCnW82R2vmpeCRA==} + + compare-versions@6.1.1: + resolution: {integrity: sha512-4hm4VPpIecmlg59CHXnRDnqGplJFrbLG4aFEl5vl6cK1u76ws3LLvX7ikFnTDl5vo39sjWD6AaDPYodJp/NNHg==} + + concat-map@0.0.1: + resolution: {integrity: sha512-/Srv4dswyQNBfohGpz9o6Yb3Gz3SrUDqBH5rTuhGR7ahtlbYKnVxw2bCFMRljaA7EXHaXZ8wsHdodFvbkhKmqg==} + + concat-stream@1.6.2: + resolution: {integrity: sha512-27HBghJxjiZtIk3Ycvn/4kbJk/1uZuJFfuPEns6LaEvpvG1f0hTea8lilrouyo9mVc2GWdcEZ8OLoGmSADlrCw==} + engines: {'0': node >= 0.8} + + conventional-changelog-angular@6.0.0: + resolution: {integrity: sha512-6qLgrBF4gueoC7AFVHu51nHL9pF9FRjXrH+ceVf7WmAfH3gs+gEYOkvxhjMPjZu57I4AGUGoNTY8V7Hrgf1uqg==} + engines: {node: '>=14'} + + conventional-changelog-conventionalcommits@6.1.0: + resolution: {integrity: sha512-3cS3GEtR78zTfMzk0AizXKKIdN4OvSh7ibNz6/DPbhWWQu7LqE/8+/GqSodV+sywUR2gpJAdP/1JFf4XtN7Zpw==} + engines: {node: '>=14'} + + conventional-commit-types@3.0.0: + resolution: {integrity: sha512-SmmCYnOniSsAa9GqWOeLqc179lfr5TRu5b4QFDkbsrJ5TZjPJx85wtOr3zn+1dbeNiXDKGPbZ72IKbPhLXh/Lg==} + + conventional-commits-parser@4.0.0: + resolution: {integrity: sha512-WRv5j1FsVM5FISJkoYMR6tPk07fkKT0UodruX4je86V4owk451yjXAKzKAPOs9l7y59E2viHUS9eQ+dfUA9NSg==} + engines: {node: '>=14'} + hasBin: true + + convert-source-map@1.9.0: + resolution: {integrity: sha512-ASFBup0Mz1uyiIjANan1jzLQami9z1PoYSZCiiYW2FczPbenXc45FZdBZLzOT+r6+iciuEModtmCti+hjaAk0A==} + + cookie@0.4.2: + resolution: {integrity: sha512-aSWTXFzaKWkvHO1Ny/s+ePFpvKsPnjc551iI41v3ny/ow6tBG5Vd+FuqGNhh1LxOmVzOlGUriIlOaokOvhaStA==} + engines: {node: '>= 0.6'} + + core-util-is@1.0.3: + resolution: {integrity: sha512-ZQBvi1DcpJ4GDqanjucZ2Hj3wEO5pZDS89BWbkcrvdxksJorwUDDZamX9ldFkp9aw2lmBDLgkObEA4DWNJ9FYQ==} + + cosmiconfig-typescript-loader@4.4.0: + resolution: {integrity: sha512-BabizFdC3wBHhbI4kJh0VkQP9GkBfoHPydD0COMce1nJ1kJAB3F2TmJ/I7diULBKtmEWSwEbuN/KDtgnmUUVmw==} + engines: {node: '>=v14.21.3'} + peerDependencies: + '@types/node': '*' + cosmiconfig: '>=7' + ts-node: '>=10' + typescript: '>=4' + + cosmiconfig-typescript-loader@5.0.0: + resolution: {integrity: sha512-+8cK7jRAReYkMwMiG+bxhcNKiHJDM6bR9FD/nGBXOWdMLuYawjF5cGrtLilJ+LGd3ZjCXnJjR5DkfWPoIVlqJA==} + engines: {node: '>=v16'} + peerDependencies: + '@types/node': '*' + cosmiconfig: '>=8.2' + typescript: '>=4' + + cosmiconfig@8.3.6: + resolution: {integrity: sha512-kcZ6+W5QzcJ3P1Mt+83OUv/oHFqZHIx8DuxG6eZ5RGMERoLqp4BuGjhHLYGK+Kf5XVkQvqBSmAy/nGWN3qDgEA==} + engines: {node: '>=14'} + peerDependencies: + typescript: '>=4.9.5' + peerDependenciesMeta: + typescript: + optional: true + + cosmiconfig@9.0.0: + resolution: {integrity: sha512-itvL5h8RETACmOTFc4UfIyB2RfEHi71Ax6E/PivVxq9NseKbOWpeyHEOIbmAw1rs8Ak0VursQNww7lf7YtUwzg==} + engines: {node: '>=14'} + peerDependencies: + typescript: '>=4.9.5' + peerDependenciesMeta: + typescript: + optional: true + + create-hash@1.2.0: + resolution: {integrity: sha512-z00bCGNHDG8mHAkP7CtT1qVu+bFQUPjYq/4Iv3C3kWjTFV10zIjfSoeqXo9Asws8gwSHDGj/hl2u4OGIjapeCg==} + + create-hmac@1.1.7: + resolution: {integrity: sha512-MJG9liiZ+ogc4TzUwuvbER1JRdgvUFSB5+VR/g5h82fGaIRWMWddtKBHi7/sVhfjQZ6SehlyhvQYrcYkaUIpLg==} + + create-require@1.1.1: + resolution: {integrity: sha512-dcKFX3jn0MpIaXjisoRvexIJVEKzaq7z2rZKxf+MSr9TkdmHmsU4m2lcLojrj/FHl8mk5VxMmYA+ftRkP/3oKQ==} + + cross-env@7.0.3: + resolution: {integrity: sha512-+/HKd6EgcQCJGh2PSjZuUitQBQynKor4wrFbRg4DtAgS1aWO+gU52xpH7M9ScGgXSYmAVS9bIJ8EzuaGw0oNAw==} + engines: {node: '>=10.14', npm: '>=6', yarn: '>=1'} + hasBin: true + + cross-spawn@7.0.3: + resolution: {integrity: sha512-iRDPJKUPVEND7dHPO8rkbOnPpyDygcDFtWjpeWNCgy8WP2rXcxXL8TskReQl6OrB2G7+UJrags1q15Fudc7G6w==} + engines: {node: '>= 8'} + + crypt@0.0.2: + resolution: {integrity: sha512-mCxBlsHFYh9C+HVpiEacem8FEBnMXgU9gy4zmNC+SXAZNB/1idgp/aulFJ4FgCi7GPEVbfyng092GqL2k2rmow==} + + cz-conventional-changelog@3.3.0: + resolution: {integrity: sha512-U466fIzU5U22eES5lTNiNbZ+d8dfcHcssH4o7QsdWaCcRs/feIPCxKYSWkYBNs5mny7MvEfwpTLWjvbm94hecw==} + engines: {node: '>= 10'} + + dargs@7.0.0: + resolution: {integrity: sha512-2iy1EkLdlBzQGvbweYRFxmFath8+K7+AKB0TlhHWkNuH+TmovaMH/Wp7V7R4u7f4SnX3OgLsU9t1NI9ioDnUpg==} + engines: {node: '>=8'} + + death@1.1.0: + resolution: {integrity: sha512-vsV6S4KVHvTGxbEcij7hkWRv0It+sGGWVOM67dQde/o5Xjnr+KmLjxWJii2uEObIrt1CcM9w0Yaovx+iOlIL+w==} + + debug@4.3.4: + resolution: {integrity: sha512-PRWFHuSU3eDtQJPvnNY7Jcket1j0t5OuOsFzPPzsekD52Zl8qUfFIPEiswXqIvHWGVHOgX+7G/vCNNhehwxfkQ==} + engines: {node: '>=6.0'} + peerDependencies: + supports-color: '*' + peerDependenciesMeta: + supports-color: + optional: true + + debug@4.3.7: + resolution: {integrity: sha512-Er2nc/H7RrMXZBFCEim6TCmMk02Z8vLC2Rbi1KEBggpo0fS6l0S1nnapwmIi3yW/+GOJap1Krg4w0Hg80oCqgQ==} + engines: {node: '>=6.0'} + peerDependencies: + supports-color: '*' + peerDependenciesMeta: + supports-color: + optional: true + + decamelize-keys@1.1.1: + resolution: {integrity: sha512-WiPxgEirIV0/eIOMcnFBA3/IJZAZqKnwAwWyvvdi4lsr1WCN22nhdf/3db3DoZcUjTV2SqfzIwNyp6y2xs3nmg==} + engines: {node: '>=0.10.0'} + + decamelize@1.2.0: + resolution: {integrity: sha512-z2S+W9X73hAUUki+N+9Za2lBlun89zigOyGrsax+KUQ6wKW4ZoWpEYBkGhQjwAjjDCkWxhY0VKEhk8wzY7F5cA==} + engines: {node: '>=0.10.0'} + + decamelize@4.0.0: + resolution: {integrity: sha512-9iE1PgSik9HeIIw2JO94IidnE3eBoQrFJ3w7sFuzSX4DpmZ3v5sZpUiV5Swcf6mQEF+Y0ru8Neo+p+nyh2J+hQ==} + engines: {node: '>=10'} + + dedent@0.7.0: + resolution: {integrity: sha512-Q6fKUPqnAHAyhiUgFU7BUzLiv0kd8saH9al7tnu5Q/okj6dnupxyTgFIBjVzJATdfIAm9NAsvXNzjaKa+bxVyA==} + + deep-eql@4.1.4: + resolution: {integrity: sha512-SUwdGfqdKOwxCPeVYjwSyRpJ7Z+fhpwIAtmCUdZIWZ/YP5R9WAsyuSgpLVDi9bjWoN2LXHNss/dk3urXtdQxGg==} + engines: {node: '>=6'} + + deep-extend@0.6.0: + resolution: {integrity: sha512-LOHxIOaPYdHlJRtCQfDIVZtfw/ufM8+rVj649RIHzcm/vGwQRXFt6OPqIFWsm2XEMrNIEtWR64sY1LEKD2vAOA==} + engines: {node: '>=4.0.0'} + + deep-is@0.1.4: + resolution: {integrity: sha512-oIPzksmTg4/MriiaYGO+okXDT7ztn/w3Eptv/+gSIdMdKsJo0u4CfYNFJPy+4SKMuCqGw2wxnA+URMg3t8a/bQ==} + + deepmerge@4.3.1: + resolution: {integrity: sha512-3sUqbMEc77XqpdNO7FRyRog+eW3ph+GYCbj+rK+uYyRMuwsVy0rMiVtPn+QJlKFvWP/1PYpapqYn0Me2knFn+A==} + engines: {node: '>=0.10.0'} + + defaults@1.0.4: + resolution: {integrity: sha512-eFuaLoy/Rxalv2kr+lqMlUnrDWV+3j4pljOIJgLIhI058IQfWJ7vXhyEIHu+HtC738klGALYxOKDO0bQP3tg8A==} + + define-data-property@1.1.4: + resolution: {integrity: sha512-rBMvIzlpA8v6E+SJZoo++HAYqsLrkg7MSfIinMPFhmkorw7X+dOXVJQs+QT69zGkzMyfDnIMN2Wid1+NbL3T+A==} + engines: {node: '>= 0.4'} + + define-lazy-prop@2.0.0: + resolution: {integrity: sha512-Ds09qNh8yw3khSjiJjiUInaGX9xlqZDY7JVryGxdxV7NPeuqQfplOpQ66yJFZut3jLa5zOwkXw1g9EI2uKh4Og==} + engines: {node: '>=8'} + + delayed-stream@1.0.0: + resolution: {integrity: sha512-ZySD7Nf91aLB0RxL4KGrKHBXl7Eds1DAmEdcoVawXnLD7SDhpNgtuII2aAkg7a7QS41jxPSZ17p4VdGnMHk3MQ==} + engines: {node: '>=0.4.0'} + + delete-empty@3.0.0: + resolution: {integrity: sha512-ZUyiwo76W+DYnKsL3Kim6M/UOavPdBJgDYWOmuQhYaZvJH0AXAHbUNyEDtRbBra8wqqr686+63/0azfEk1ebUQ==} + engines: {node: '>=10'} + hasBin: true + + depd@2.0.0: + resolution: {integrity: sha512-g7nH6P6dyDioJogAAGprGpCtVImJhpPk/roCzdb3fIh61/s/nPsfR6onyMwkCAR/OlC3yBC0lESvUoQEAssIrw==} + engines: {node: '>= 0.8'} + + detect-file@1.0.0: + resolution: {integrity: sha512-DtCOLG98P007x7wiiOmfI0fi3eIKyWiLTGJ2MDnVi/E04lWGbf+JzrRHMm0rgIIZJGtHpKpbVgLWHrv8xXpc3Q==} + engines: {node: '>=0.10.0'} + + detect-indent@6.1.0: + resolution: {integrity: sha512-reYkTUJAZb9gUuZ2RvVCNhVHdg62RHnJ7WJl8ftMi4diZ6NWlciOzQN88pUhSELEwflJht4oQDv0F0BMlwaYtA==} + engines: {node: '>=8'} + + diff@4.0.2: + resolution: {integrity: sha512-58lmxKSA4BNyLz+HHMUzlOEpg09FV+ev6ZMe3vJihgdxzgcwZ8VoEEPmALCZG9LmqfVoNMMKpttIYTVG6uDY7A==} + engines: {node: '>=0.3.1'} + + diff@5.2.0: + resolution: {integrity: sha512-uIFDxqpRZGZ6ThOk84hEfqWoHx2devRFvpTZcTHur85vImfaxUbTW9Ryh4CpCuDnToOP1CEtXKIgytHBPVff5A==} + engines: {node: '>=0.3.1'} + + difflib@0.2.4: + resolution: {integrity: sha512-9YVwmMb0wQHQNr5J9m6BSj6fk4pfGITGQOOs+D9Fl+INODWFOfvhIU1hNv6GgR1RBoC/9NJcwu77zShxV0kT7w==} + + dir-glob@3.0.1: + resolution: {integrity: sha512-WkrWp9GR4KXfKGYzOLmTuGVi1UWFfws377n9cc55/tb6DuqyF6pcQ5AbiHEshaDpY9v6oaSr2XCDidGmMwdzIA==} + engines: {node: '>=8'} + + doctrine@3.0.0: + resolution: {integrity: sha512-yS+Q5i3hBf7GBkd4KG8a7eBNNWNGLTaEwwYWUijIYM7zrlYDM0BFXHjjPWlWZ1Rg7UaddZeIDmi9jF3HmqiQ2w==} + engines: {node: '>=6.0.0'} + + dot-prop@5.3.0: + resolution: {integrity: sha512-QM8q3zDe58hqUqjraQOmzZ1LIH9SWQJTlEKCH4kJ2oQvLZk7RbQXvtDM2XEq3fwkV9CCvvH4LA0AV+ogFsBM2Q==} + engines: {node: '>=8'} + + dotenv@16.4.5: + resolution: {integrity: sha512-ZmdL2rui+eB2YwhsWzjInR8LldtZHGDoQ1ugH85ppHKwpUHL7j7rN0Ti9NCnGiQbhaZ11FpR+7ao1dNsmduNUg==} + engines: {node: '>=12'} + + eastasianwidth@0.2.0: + resolution: {integrity: sha512-I88TYZWc9XiYHRQ4/3c5rjjfgkjhLyW2luGIheGERbNQ6OY7yTybanSpDXZa8y7VUP9YmDcYa+eyq4ca7iLqWA==} + + electron-to-chromium@1.5.19: + resolution: {integrity: sha512-kpLJJi3zxTR1U828P+LIUDZ5ohixyo68/IcYOHLqnbTPr/wdgn4i1ECvmALN9E16JPA6cvCG5UG79gVwVdEK5w==} + + elliptic@6.5.4: + resolution: {integrity: sha512-iLhC6ULemrljPZb+QutR5TQGB+pdW6KGD5RSegS+8sorOZT+rdQFbsQFJgvN3eRqNALqJer4oQ16YvJHlU8hzQ==} + + elliptic@6.5.7: + resolution: {integrity: sha512-ESVCtTwiA+XhY3wyh24QqRGBoP3rEdDUl3EDUUo9tft074fi19IrdpH7hLCMMP3CIj7jb3W96rn8lt/BqIlt5Q==} + + emoji-regex@8.0.0: + resolution: {integrity: sha512-MSjYzcWNOA0ewAHpz0MxpYFvwg6yjy1NG3xteoqz644VCo/RPgnr1/GGt+ic3iJTzQ8Eu3TdM14SawnVUmGE6A==} + + emoji-regex@9.2.2: + resolution: {integrity: sha512-L18DaJsXSUk2+42pv8mLs5jJT2hqFkFE4j21wOmgbUqsZ2hL72NsUU785g9RXgo3s0ZNgVl42TiHp3ZtOv/Vyg==} + + encode-utf8@1.0.3: + resolution: {integrity: sha512-ucAnuBEhUK4boH2HjVYG5Q2mQyPorvv0u/ocS+zhdw0S8AlHYY+GOFhP1Gio5z4icpP2ivFSvhtFjQi8+T9ppw==} + + enquirer@2.4.1: + resolution: {integrity: sha512-rRqJg/6gd538VHvR3PSrdRBb/1Vy2YfzHqzvbhGIQpDRKIa4FgV/54b5Q1xYSxOOwKvjXweS26E0Q+nAMwp2pQ==} + engines: {node: '>=8.6'} + + entities@4.5.0: + resolution: {integrity: sha512-V0hjH4dGPh9Ao5p0MoRY6BVqtwCjhz6vI5LT8AJ55H+4g9/4vbHx1I54fS0XuclLhDHArPQCiMjDxjaL8fPxhw==} + engines: {node: '>=0.12'} + + env-paths@2.2.1: + resolution: {integrity: sha512-+h1lkLKhZMTYjog1VEpJNG7NZJWcuc2DDk/qsqSTRRCOXiLjeQ1d1/udrUGhqMxUgAlwKNZ0cf2uqan5GLuS2A==} + engines: {node: '>=6'} + + error-ex@1.3.2: + resolution: {integrity: sha512-7dFHNmqeFSEt2ZBsCriorKnn3Z2pj+fd9kmI6QoWw4//DL+icEBfc0U7qJCisqrTsKTjw4fNFy2pW9OqStD84g==} + + es-define-property@1.0.0: + resolution: {integrity: sha512-jxayLKShrEqqzJ0eumQbVhTYQM27CfT1T35+gCgDFoL82JLsXqTJ76zv6A0YLOgEnLUMvLzsDsGIrl8NFpT2gQ==} + engines: {node: '>= 0.4'} + + es-errors@1.3.0: + resolution: {integrity: sha512-Zf5H2Kxt2xjTvbJvP2ZWLEICxA6j+hAmMzIlypy4xcBg1vKVnx89Wy0GbS+kf5cwCVFFzdCFh2XSCFNULS6csw==} + engines: {node: '>= 0.4'} + + es-module-lexer@1.5.4: + resolution: {integrity: sha512-MVNK56NiMrOwitFB7cqDwq0CQutbw+0BvLshJSse0MUNU+y1FC3bUS/AQg7oUng+/wKrrki7JfmwtVHkVfPLlw==} + + esbuild@0.23.1: + resolution: {integrity: sha512-VVNz/9Sa0bs5SELtn3f7qhJCDPCF5oMEl5cO9/SSinpE9hbPVvxbd572HH5AKiP7WD8INO53GgfDDhRjkylHEg==} + engines: {node: '>=18'} + hasBin: true + + escalade@3.2.0: + resolution: {integrity: sha512-WUj2qlxaQtO4g6Pq5c29GTcWGDyd8itL8zTlipgECz3JesAiiOKotd8JU6otB3PACgG6xkJUyVhboMS+bje/jA==} + engines: {node: '>=6'} + + escape-string-regexp@1.0.5: + resolution: {integrity: sha512-vbRorB5FUQWvla16U8R/qgaFIya2qGzwDrNmCZuYKrbdSUMG6I1ZCGQRefkRVhuOkIGVne7BQ35DSfo1qvJqFg==} + engines: {node: '>=0.8.0'} + + escape-string-regexp@4.0.0: + resolution: {integrity: sha512-TtpcNJ3XAzx3Gq8sWRzJaVajRs0uVxA2YAkdb1jm2YkPz4G6egUFAyA3n5vtEIZefPk5Wa4UXbKuS5fKkJWdgA==} + engines: {node: '>=10'} + + escodegen@1.8.1: + resolution: {integrity: sha512-yhi5S+mNTOuRvyW4gWlg5W1byMaQGWWSYHXsuFZ7GBo7tpyOwi2EdzMP/QWxh9hwkD2m+wDVHJsxhRIj+v/b/A==} + engines: {node: '>=0.12.0'} + hasBin: true + + eslint-config-prettier@8.10.0: + resolution: {integrity: sha512-SM8AMJdeQqRYT9O9zguiruQZaN7+z+E4eAP9oiLNGKMtomwaB1E9dcgUD6ZAn/eQAb52USbvezbiljfZUhbJcg==} + hasBin: true + peerDependencies: + eslint: '>=7.0.0' + + eslint-scope@7.2.2: + resolution: {integrity: sha512-dOt21O7lTMhDM+X9mB4GX+DZrZtCUJPL/wlcTqxyrx5IvO0IYtILdtrQGQp+8n5S0gwSVmOf9NQrjMOgfQZlIg==} + engines: {node: ^12.22.0 || ^14.17.0 || >=16.0.0} + + eslint-visitor-keys@3.4.3: + resolution: {integrity: sha512-wpc+LXeiyiisxPlEkUzU6svyS1frIO3Mgxj1fdy7Pm8Ygzguax2N3Fa/D/ag1WqbOprdI+uY6wMUl8/a2G+iag==} + engines: {node: ^12.22.0 || ^14.17.0 || >=16.0.0} + + eslint@8.57.0: + resolution: {integrity: sha512-dZ6+mexnaTIbSBZWgou51U6OmzIhYM2VcNdtiTtI7qPNZm35Akpr0f6vtw3w1Kmn5PYo+tZVfh13WrhpS6oLqQ==} + engines: {node: ^12.22.0 || ^14.17.0 || >=16.0.0} + hasBin: true + + espree@9.6.1: + resolution: {integrity: sha512-oruZaFkjorTpF32kDSI5/75ViwGeZginGGy2NoOSg3Q9bnwlnmDm4HLnkl0RE3n+njDXR037aY1+x58Z/zFdwQ==} + engines: {node: ^12.22.0 || ^14.17.0 || >=16.0.0} + + esprima@2.7.3: + resolution: {integrity: sha512-OarPfz0lFCiW4/AV2Oy1Rp9qu0iusTKqykwTspGCZtPxmF81JR4MmIebvF1F9+UOKth2ZubLQ4XGGaU+hSn99A==} + engines: {node: '>=0.10.0'} + hasBin: true + + esprima@4.0.1: + resolution: {integrity: sha512-eGuFFw7Upda+g4p+QHvnW0RyTX/SVeJBDM/gCtMARO0cLuT2HcEKnTPvhjV6aGeqrCB/sbNop0Kszm0jsaWU4A==} + engines: {node: '>=4'} + hasBin: true + + esquery@1.6.0: + resolution: {integrity: sha512-ca9pw9fomFcKPvFLXhBKUK90ZvGibiGOvRJNbjljY7s7uq/5YO4BOzcYtJqExdx99rF6aAcnRxHmcUHcz6sQsg==} + engines: {node: '>=0.10'} + + esrecurse@4.3.0: + resolution: {integrity: sha512-KmfKL3b6G+RXvP8N1vr3Tq1kL/oCFgn2NYXEtqP8/L3pKapUA4G8cFVaoF3SU323CD4XypR/ffioHmkti6/Tag==} + engines: {node: '>=4.0'} + + estraverse@1.9.3: + resolution: {integrity: sha512-25w1fMXQrGdoquWnScXZGckOv+Wes+JDnuN/+7ex3SauFRS72r2lFDec0EKPt2YD1wUJ/IrfEex+9yp4hfSOJA==} + engines: {node: '>=0.10.0'} + + estraverse@5.3.0: + resolution: {integrity: sha512-MMdARuVEQziNTeJD8DgMqmhwR11BRQ/cBP+pLtYdSTnf3MIO8fFeiINEbX36ZdNlfU/7A9f3gUw49B3oQsvwBA==} + engines: {node: '>=4.0'} + + estree-walker@0.6.1: + resolution: {integrity: sha512-SqmZANLWS0mnatqbSfRP5g8OXZC12Fgg1IwNtLsyHDzJizORW4khDfjPqJZsemPWBB2uqykUah5YpQ6epsqC/w==} + + estree-walker@2.0.2: + resolution: {integrity: sha512-Rfkk/Mp/DL7JVje3u18FxFujQlTNR2q6QfMSMB7AvCBx91NGj/ba3kCfza0f6dVDbw7YlRf/nDrn7pQrCCyQ/w==} + + esutils@2.0.3: + resolution: {integrity: sha512-kVscqXk4OCp68SZ0dkgEKVi6/8ij300KBWTJq32P/dYeWTSwK41WyTxalN1eRmA5Z9UU/LX9D7FWSmV9SAYx6g==} + engines: {node: '>=0.10.0'} + + eth-gas-reporter@0.2.27: + resolution: {integrity: sha512-femhvoAM7wL0GcI8ozTdxfuBtBFJ9qsyIAsmKVjlWAHUbdnnXHt+lKzz/kmldM5lA9jLuNHGwuIxorNpLbR1Zw==} + peerDependencies: + '@codechecks/client': ^0.1.0 + peerDependenciesMeta: + '@codechecks/client': + optional: true + + ethereum-bloom-filters@1.2.0: + resolution: {integrity: sha512-28hyiE7HVsWubqhpVLVmZXFd4ITeHi+BUu05o9isf0GUpMtzBUi+8/gFrGaGYzvGAJQmJ3JKj77Mk9G98T84rA==} + + ethereum-cryptography@0.1.3: + resolution: {integrity: sha512-w8/4x1SGGzc+tO97TASLja6SLd3fRIK2tLVcV2Gx4IB21hE19atll5Cq9o3d0ZmAYC/8aw0ipieTSiekAea4SQ==} + + ethereum-cryptography@1.2.0: + resolution: {integrity: sha512-6yFQC9b5ug6/17CQpCyE3k9eKBMdhyVjzUy1WkiuY/E4vj/SXDBbCw8QEIaXqf0Mf2SnY6RmpDcwlUmBSS0EJw==} + + ethereum-cryptography@2.2.1: + resolution: {integrity: sha512-r/W8lkHSiTLxUxW8Rf3u4HGB0xQweG2RyETjywylKZSzLWoWAijRz8WCuOtJ6wah+avllXBqZuk29HCCvhEIRg==} + + ethereumjs-abi@0.6.8: + resolution: {integrity: sha512-Tx0r/iXI6r+lRsdvkFDlut0N08jWMnKRZ6Gkq+Nmw75lZe4e6o3EkSnkaBP5NF6+m5PTGAr9JP43N3LyeoglsA==} + + ethereumjs-util@6.2.1: + resolution: {integrity: sha512-W2Ktez4L01Vexijrm5EB6w7dg4n/TgpoYU4avuT5T3Vmnw/eCRtiBrJfQYS/DCSvDIOLn2k57GcHdeBcgVxAqw==} + + ethereumjs-util@7.1.5: + resolution: {integrity: sha512-SDl5kKrQAudFBUe5OJM9Ac6WmMyYmXX/6sTmLZ3ffG2eY6ZIGBes3pEDxNN6V72WyOw4CPD5RomKdsa8DAAwLg==} + engines: {node: '>=10.0.0'} + + ethers@5.7.2: + resolution: {integrity: sha512-wswUsmWo1aOK8rR7DIKiWSw9DbLWe6x98Jrn8wcTflTVvaXhAMaB5zGAXy0GYQEQp9iO1iSHWVyARQm11zUtyg==} + + ethers@6.13.2: + resolution: {integrity: sha512-9VkriTTed+/27BGuY1s0hf441kqwHJ1wtN2edksEtiRvXx+soxRX3iSXTfFqq2+YwrOqbDoTHjIhQnjJRlzKmg==} + engines: {node: '>=14.0.0'} + + ethjs-unit@0.1.6: + resolution: {integrity: sha512-/Sn9Y0oKl0uqQuvgFk/zQgR7aw1g36qX/jzSQ5lSwlO0GigPymk4eGQfeNTD03w1dPOqfz8V77Cy43jH56pagw==} + engines: {node: '>=6.5.0', npm: '>=3'} + + ethjs-util@0.1.6: + resolution: {integrity: sha512-CUnVOQq7gSpDHZVVrQW8ExxUETWrnrvXYvYz55wOU8Uj4VCgw56XC2B/fVqQN+f7gmrnRHSLVnFAwsCuNwji8w==} + engines: {node: '>=6.5.0', npm: '>=3'} + + eventemitter3@5.0.1: + resolution: {integrity: sha512-GWkBvjiSZK87ELrYOSESUYeVIc9mvLLf/nXalMOS5dYrgZq9o5OVkbZAVM06CVxYsCwH9BDZFPlQTlPA1j4ahA==} + + evp_bytestokey@1.0.3: + resolution: {integrity: sha512-/f2Go4TognH/KvCISP7OUsHn85hT9nUkxxA9BEWxFn+Oj9o8ZNLm/40hdlgSLyuOimsrTKLUMEorQexp/aPQeA==} + + execa@5.1.1: + resolution: {integrity: sha512-8uSpZZocAZRBAPIEINJj3Lo9HyGitllczc27Eh5YYojjMFMn8yHMDMaUHE2Jqfq05D/wucwI4JGURyXt1vchyg==} + engines: {node: '>=10'} + + execa@7.2.0: + resolution: {integrity: sha512-UduyVP7TLB5IcAQl+OzLyLcS/l32W/GLg+AhHJ+ow40FOk2U3SAllPwR44v4vmdFwIWqpdwxxpQbF1n5ta9seA==} + engines: {node: ^14.18.0 || ^16.14.0 || >=18.0.0} + + expand-tilde@2.0.2: + resolution: {integrity: sha512-A5EmesHW6rfnZ9ysHQjPdJRni0SRar0tjtG5MNtm9n5TUvsYU8oozprtRD4AqHxcZWWlVuAmQo2nWKfN9oyjTw==} + engines: {node: '>=0.10.0'} + + external-editor@3.1.0: + resolution: {integrity: sha512-hMQ4CX1p1izmuLYyZqLMO/qGNw10wSv9QDCPfzXfyFrOaCSSoRfqE1Kf1s5an66J5JZC62NewG+mK49jOCtQew==} + engines: {node: '>=4'} + + fast-base64-decode@1.0.0: + resolution: {integrity: sha512-qwaScUgUGBYeDNRnbc/KyllVU88Jk1pRHPStuF/lO7B0/RTRLj7U0lkdTAutlBblY08rwZDff6tNU9cjv6j//Q==} + + fast-deep-equal@3.1.3: + resolution: {integrity: sha512-f3qQ9oQy9j2AhBe/H9VC91wLmKBCCU/gDOnKNAYG5hswO7BLKj09Hc5HYNz9cGI++xlpDCIgDaitVs03ATR84Q==} + + fast-diff@1.3.0: + resolution: {integrity: sha512-VxPP4NqbUjj6MaAOafWeUn2cXWLcCtljklUtZf0Ind4XQ+QPtmA0b18zZy0jIQx+ExRVCR/ZQpBmik5lXshNsw==} + + fast-glob@3.3.2: + resolution: {integrity: sha512-oX2ruAFQwf/Orj8m737Y5adxDQO0LAB7/S5MnxCdTNDd4p6BsyIVsv9JQsATbTSq8KHRpLwIHbVlUNatxd+1Ow==} + engines: {node: '>=8.6.0'} + + fast-json-stable-stringify@2.1.0: + resolution: {integrity: sha512-lhd/wF+Lk98HZoTCtlVraHtfh5XYijIjalXck7saUtuanSDyLMxnHhSXEDJqHxD7msR8D0uCmqlkwjCV8xvwHw==} + + fast-levenshtein@2.0.6: + resolution: {integrity: sha512-DCXu6Ifhqcks7TZKY3Hxp3y6qphY5SJZmrWMDrKcERSOXWQdMhU9Ig/PYrzyw/ul9jOIyh0N4M0tbC5hodg8dw==} + + fast-uri@3.0.1: + resolution: {integrity: sha512-MWipKbbYiYI0UC7cl8m/i/IWTqfC8YXsqjzybjddLsFjStroQzsHXkc73JutMvBiXmOvapk+axIl79ig5t55Bw==} + + fastq@1.17.1: + resolution: {integrity: sha512-sRVD3lWVIXWg6By68ZN7vho9a1pQcN/WBFaAAsDDFzlJjvoGx0P8z7V1t72grFJfJhu3YPZBuu25f7Kaw2jN1w==} + + figures@3.2.0: + resolution: {integrity: sha512-yaduQFRKLXYOGgEn6AZau90j3ggSOyiqXU0F9JZfeXYhNa+Jk4X+s45A2zg5jns87GAFa34BBm2kXw4XpNcbdg==} + engines: {node: '>=8'} + + file-entry-cache@6.0.1: + resolution: {integrity: sha512-7Gps/XWymbLk2QLYK4NzpMOrYjMhdIxXuIvy2QBsLE6ljuodKvdkWs/cpyJJ3CVIVpH0Oi1Hvg1ovbMzLdFBBg==} + engines: {node: ^10.12.0 || >=12.0.0} + + fill-range@7.1.1: + resolution: {integrity: sha512-YsGpe3WHLK8ZYi4tWDg2Jy3ebRz2rXowDxnld4bkQB00cc/1Zw9AWnC0i9ztDJitivtQvaI9KaLyKrc+hBW0yg==} + engines: {node: '>=8'} + + find-node-modules@2.1.3: + resolution: {integrity: sha512-UC2I2+nx1ZuOBclWVNdcnbDR5dlrOdVb7xNjmT/lHE+LsgztWks3dG7boJ37yTS/venXw84B/mAW9uHVoC5QRg==} + + find-replace@3.0.0: + resolution: {integrity: sha512-6Tb2myMioCAgv5kfvP5/PkZZ/ntTpVK39fHY7WkWBgvbeE+VHd/tZuZ4mrC+bxh4cfOZeYKVPaJIZtZXV7GNCQ==} + engines: {node: '>=4.0.0'} + + find-root@1.1.0: + resolution: {integrity: sha512-NKfW6bec6GfKc0SGx1e07QZY9PE99u0Bft/0rzSD5k3sO/vwkVUpDUKVm5Gpp5Ue3YfShPFTX2070tDs5kB9Ng==} + + find-up@2.1.0: + resolution: {integrity: sha512-NWzkk0jSJtTt08+FBFMvXoeZnOJD+jTtsRmBYbAIzJdX6l7dLgR7CTubCM5/eDdPUBvLCeVasP1brfVR/9/EZQ==} + engines: {node: '>=4'} + + find-up@4.1.0: + resolution: {integrity: sha512-PpOwAdQ/YlXQ2vj8a3h8IipDuYRi3wceVQQGYWxNINccq40Anw7BlsEXCMbt1Zt+OLA6Fq9suIpIWD0OsnISlw==} + engines: {node: '>=8'} + + find-up@5.0.0: + resolution: {integrity: sha512-78/PXT1wlLLDgTzDs7sjq9hzz0vXD+zn+7wypEe4fXQxCmdmqfGsEPQxmiCSQI3ajFV91bVSsvNtrJRiW6nGng==} + engines: {node: '>=10'} + + findup-sync@4.0.0: + resolution: {integrity: sha512-6jvvn/12IC4quLBL1KNokxC7wWTvYncaVUYSoxWw7YykPLuRrnv4qdHcSOywOI5RpkOVGeQRtWM8/q+G6W6qfQ==} + engines: {node: '>= 8'} + + flat-cache@3.2.0: + resolution: {integrity: sha512-CYcENa+FtcUKLmhhqyctpclsq7QF38pKjZHsGNiSQF5r4FtoKDWabFDl3hzaEQMvT1LHEysw5twgLvpYYb4vbw==} + engines: {node: ^10.12.0 || >=12.0.0} + + flat@5.0.2: + resolution: {integrity: sha512-b6suED+5/3rTpUBdG1gupIl8MPFCAMA0QXwmljLhvCUKcUvdE4gWky9zpuGCcXHOsz4J9wPGNWq6OKpmIzz3hQ==} + hasBin: true + + flatted@3.3.1: + resolution: {integrity: sha512-X8cqMLLie7KsNUDSdzeN8FYK9rEt4Dt67OsG/DNGnYTSDBG4uFAJFBnUeiV+zCVAvwFy56IjM9sH51jVaEhNxw==} + + fmix@0.1.0: + resolution: {integrity: sha512-Y6hyofImk9JdzU8k5INtTXX1cu8LDlePWDFU5sftm9H+zKCr5SGrVjdhkvsim646cw5zD0nADj8oHyXMZmCZ9w==} + + follow-redirects@1.15.9: + resolution: {integrity: sha512-gew4GsXizNgdoRyqmyfMHyAmXsZDk6mHkSxZFCzW9gwlbtOW44CDtYavM+y+72qD/Vq2l550kMF52DT8fOLJqQ==} + engines: {node: '>=4.0'} + peerDependencies: + debug: '*' + peerDependenciesMeta: + debug: + optional: true + + foreground-child@3.3.0: + resolution: {integrity: sha512-Ld2g8rrAyMYFXBhEqMz8ZAHBi4J4uS1i/CxGMDnjyFWddMXLVcDp051DZfu+t7+ab7Wv6SMqpWmyFIj5UbfFvg==} + engines: {node: '>=14'} + + form-data@2.5.1: + resolution: {integrity: sha512-m21N3WOmEEURgk6B9GLOE4RuWOFf28Lhh9qGYeNlGq4VDXUlJy2th2slBNU8Gp8EzloYZOibZJ7t5ecIrFSjVA==} + engines: {node: '>= 0.12'} + + form-data@4.0.0: + resolution: {integrity: sha512-ETEklSGi5t0QMZuiXoA/Q6vcnxcLQP5vdugSpuAyi6SVGi2clPPp+xgEhuMaHC+zGgn31Kd235W35f7Hykkaww==} + engines: {node: '>= 6'} + + fp-ts@1.19.3: + resolution: {integrity: sha512-H5KQDspykdHuztLTg+ajGN0Z2qUjcEf3Ybxc6hLt0k7/zPkn29XnKnxlBPyW2XIddWrGaJBzBl4VLYOtk39yZg==} + + fs-extra@10.1.0: + resolution: {integrity: sha512-oRXApq54ETRj4eMiFzGnHWGy+zo5raudjuxN0b8H7s/RU2oW0Wvsx9O0ACRN/kRq9E8Vu/ReskGB5o3ji+FzHQ==} + engines: {node: '>=12'} + + fs-extra@11.2.0: + resolution: {integrity: sha512-PmDi3uwK5nFuXh7XDTlVnS17xJS7vW36is2+w3xcv8SVxiB4NyATf4ctkVY5bkSjX0Y4nbvZCq1/EjtEyr9ktw==} + engines: {node: '>=14.14'} + + fs-extra@7.0.1: + resolution: {integrity: sha512-YJDaCJZEnBmcbw13fvdAM9AwNOJwOzrE4pqMqBq5nFiEqXUqHwlK4B+3pUw6JNvfSPtX05xFHtYy/1ni01eGCw==} + engines: {node: '>=6 <7 || >=8'} + + fs-extra@8.1.0: + resolution: {integrity: sha512-yhlQgA6mnOJUKOsRUFsgJdQCvkKhcz8tlZG5HBQfReYZy46OwLcY+Zia0mtdHsOo9y/hP+CxMN0TU9QxoOtG4g==} + engines: {node: '>=6 <7 || >=8'} + + fs-extra@9.1.0: + resolution: {integrity: sha512-hcg3ZmepS30/7BSFqRvoo3DOMQu7IjqxO5nCDt+zM9XWjb33Wg7ziNT+Qvqbuc3+gWpzO02JubVyk2G4Zvo1OQ==} + engines: {node: '>=10'} + + fs-readdir-recursive@1.1.0: + resolution: {integrity: sha512-GNanXlVr2pf02+sPN40XN8HG+ePaNcvM0q5mZBd668Obwb0yD5GiUbZOFgwn8kGMY6I3mdyDJzieUy3PTYyTRA==} + + fs.realpath@1.0.0: + resolution: {integrity: sha512-OO0pH2lK6a0hZnAdau5ItzHPI6pUlvI7jMVnxUQRtw4owF2wk8lOSabtGDCTP4Ggrg2MbGnWO9X8K1t4+fGMDw==} + + fsevents@2.3.3: + resolution: {integrity: sha512-5xoDfX+fL7faATnagmWPpbFtwh/R77WmMMqqHGS65C3vvB0YHrgF+B1YmZ3441tMj5n63k0212XNoJwzlhffQw==} + engines: {node: ^8.16.0 || ^10.6.0 || >=11.0.0} + os: [darwin] + + function-bind@1.1.2: + resolution: {integrity: sha512-7XHNxH7qX9xG5mIwxkhumTox/MIRNcOgDrxWsMt2pAr23WHp6MrRlN7FBSFpCpr+oVO0F744iUgR82nJMfG2SA==} + + gensync@1.0.0-beta.2: + resolution: {integrity: sha512-3hN7NaskYvMDLQY55gnW3NQ+mesEAepTqlg+VEbj7zzqEMBVNhzcGYYeqFo/TlYz6eQiFcp1HcsCZO+nGgS8zg==} + engines: {node: '>=6.9.0'} + + get-caller-file@2.0.5: + resolution: {integrity: sha512-DyFP3BM/3YHTQOCUL/w0OZHR0lpKeGrxotcHWcqNEdnltqFwXVfhEBQ94eIo34AfQpo0rGki4cyIiftY06h2Fg==} + engines: {node: 6.* || 8.* || >= 10.*} + + get-func-name@2.0.2: + resolution: {integrity: sha512-8vXOvuE167CtIc3OyItco7N/dpRtBbYOsPsXCz7X/PMnlGjYjSGuZJgM1Y7mmew7BKf9BqvLX2tnOVy1BBUsxQ==} + + get-intrinsic@1.2.4: + resolution: {integrity: sha512-5uYhsJH8VJBTv7oslg4BznJYhDoRI6waYCxMmCdnTrcCrHA/fCFKoTFz2JKKE0HdDFUF7/oQuhzumXJK7paBRQ==} + engines: {node: '>= 0.4'} + + get-port@3.2.0: + resolution: {integrity: sha512-x5UJKlgeUiNT8nyo/AcnwLnZuZNcSjSw0kogRB+Whd1fjjFq4B1hySFxSFWWSn4mIBzg3sRNUDFYc4g5gjPoLg==} + engines: {node: '>=4'} + + get-stream@6.0.1: + resolution: {integrity: sha512-ts6Wi+2j3jQjqi70w5AlN8DFnkSwC+MqmxEzdEALB2qXZYV3X/b1CTfgPLGJNMeAWxdPfU8FO1ms3NUfaHCPYg==} + engines: {node: '>=10'} + + get-tsconfig@4.8.0: + resolution: {integrity: sha512-Pgba6TExTZ0FJAn1qkJAjIeKoDJ3CsI2ChuLohJnZl/tTU8MVrq3b+2t5UOPfRa4RMsorClBjJALkJUMjG1PAw==} + + ghost-testrpc@0.0.2: + resolution: {integrity: sha512-i08dAEgJ2g8z5buJIrCTduwPIhih3DP+hOCTyyryikfV8T0bNvHnGXO67i0DD1H4GBDETTclPy9njZbfluQYrQ==} + hasBin: true + + git-raw-commits@2.0.11: + resolution: {integrity: sha512-VnctFhw+xfj8Va1xtfEqCUD2XDrbAPSJx+hSrE5K7fGdjZruW7XV+QOrN7LF/RJyvspRiD2I0asWsxFp0ya26A==} + engines: {node: '>=10'} + hasBin: true + + glob-parent@5.1.2: + resolution: {integrity: sha512-AOIgSQCepiJYwP3ARnGx+5VnTu2HBYdzbGP45eLw1vr3zB3vZLeyed1sC9hnbcOc9/SrMyM5RPQrkGz4aS9Zow==} + engines: {node: '>= 6'} + + glob-parent@6.0.2: + resolution: {integrity: sha512-XxwI8EOhVQgWp6iDL+3b0r86f4d6AX6zSU55HfB4ydCEuXLXc5FcYeOu+nnGftS4TEju/11rt4KJPTMgbfmv4A==} + engines: {node: '>=10.13.0'} + + glob@10.4.5: + resolution: {integrity: sha512-7Bv8RF0k6xjo7d4A/PxYLbUCfb6c+Vpd2/mB2yRDlew7Jb5hEXiCD9ibfO7wpk8i4sevK6DFny9h7EYbM3/sHg==} + hasBin: true + + glob@5.0.15: + resolution: {integrity: sha512-c9IPMazfRITpmAAKi22dK1VKxGDX9ehhqfABDriL/lzO92xcUKEJPQHrVA/2YHSNFB4iFlykVmWvwo48nr3OxA==} + deprecated: Glob versions prior to v9 are no longer supported + + glob@7.1.7: + resolution: {integrity: sha512-OvD9ENzPLbegENnYP5UUfJIirTg4+XwMWGaQfQTY0JenxNvvIKP3U3/tAQSPIu/lHxXYSZmpXlUHeqAIdKzBLQ==} + deprecated: Glob versions prior to v9 are no longer supported + + glob@7.2.0: + resolution: {integrity: sha512-lmLf6gtyrPq8tTjSmrO94wBeQbFR3HbLHbuyD69wuyQkImp2hWqMGB47OX65FBkPffO641IP9jWa1z4ivqG26Q==} + deprecated: Glob versions prior to v9 are no longer supported + + glob@7.2.3: + resolution: {integrity: sha512-nFR0zLpU2YCaRxwoCJvL6UvCH2JFyFVIvwTLsIf21AuHlMskA1hhTdk+LlYJtOlYt9v6dvszD2BGRqBL+iQK9Q==} + deprecated: Glob versions prior to v9 are no longer supported + + glob@8.1.0: + resolution: {integrity: sha512-r8hpEjiQEYlF2QU0df3dS+nxxSIreXQS1qRhMJM0Q5NDdR386C7jb7Hwwod8Fgiuex+k0GFjgft18yvxm5XoCQ==} + engines: {node: '>=12'} + deprecated: Glob versions prior to v9 are no longer supported + + global-directory@4.0.1: + resolution: {integrity: sha512-wHTUcDUoZ1H5/0iVqEudYW4/kAlN5cZ3j/bXn0Dpbizl9iaUVeWSHqiOjsgk6OW2bkLclbBjzewBz6weQ1zA2Q==} + engines: {node: '>=18'} + + global-dirs@0.1.1: + resolution: {integrity: sha512-NknMLn7F2J7aflwFOlGdNIuCDpN3VGoSoB+aap3KABFWbHVn1TCgFC+np23J8W2BiZbjfEw3BFBycSMv1AFblg==} + engines: {node: '>=4'} + + global-modules@1.0.0: + resolution: {integrity: sha512-sKzpEkf11GpOFuw0Zzjzmt4B4UZwjOcG757PPvrfhxcLFbq0wpsgpOqxpxtxFiCG4DtG93M6XRVbF2oGdev7bg==} + engines: {node: '>=0.10.0'} + + global-modules@2.0.0: + resolution: {integrity: sha512-NGbfmJBp9x8IxyJSd1P+otYK8vonoJactOogrVfFRIAEY1ukil8RSKDz2Yo7wh1oihl51l/r6W4epkeKJHqL8A==} + engines: {node: '>=6'} + + global-prefix@1.0.2: + resolution: {integrity: sha512-5lsx1NUDHtSjfg0eHlmYvZKv8/nVqX4ckFbM+FrGcQ+04KWcWFo9P5MxPZYSzUvyzmdTbI7Eix8Q4IbELDqzKg==} + engines: {node: '>=0.10.0'} + + global-prefix@3.0.0: + resolution: {integrity: sha512-awConJSVCHVGND6x3tmMaKcQvwXLhjdkmomy2W+Goaui8YPgYgXJZewhg3fWC+DlfqqQuWg8AwqjGTD2nAPVWg==} + engines: {node: '>=6'} + + globals@11.12.0: + resolution: {integrity: sha512-WOBp/EEGUiIsJSp7wcv/y6MO+lV9UoncWqxuFfm8eBwzWNgyfBd6Gz+IeKQ9jCmyhoH99g15M3T+QaVHFjizVA==} + engines: {node: '>=4'} + + globals@13.24.0: + resolution: {integrity: sha512-AhO5QUcj8llrbG09iWhPU2B204J1xnPeL8kQmVorSsy+Sjj1sk8gIyh6cUocGmH4L0UuhAJy+hJMRA4mgA4mFQ==} + engines: {node: '>=8'} + + globby@10.0.2: + resolution: {integrity: sha512-7dUi7RvCoT/xast/o/dLN53oqND4yk0nsHkhRgn9w65C4PofCLOoJ39iSOg+qVDdWQPIEj+eszMHQ+aLVwwQSg==} + engines: {node: '>=8'} + + globby@11.1.0: + resolution: {integrity: sha512-jhIXaOzy1sb8IyocaruWSn1TjmnBVs8Ayhcy83rmxNJ8q2uWKCAj3CnJY+KpGSXCueAPc0i05kVvVKtP1t9S3g==} + engines: {node: '>=10'} + + gopd@1.0.1: + resolution: {integrity: sha512-d65bNlIadxvpb/A2abVdlqKqV563juRnZ1Wtk6s1sIR8uNsXR70xqIzVqxVf1eTqDunwT2MkczEeaezCKTZhwA==} + + graceful-fs@4.2.11: + resolution: {integrity: sha512-RbJ5/jmFcNNCcDV5o9eTnBLJ/HszWV0P73bc+Ff4nS/rJj+YaS6IGyiOL0VoBYX+l1Wrl3k63h/KrH+nhJ0XvQ==} + + graphemer@1.4.0: + resolution: {integrity: sha512-EtKwoO6kxCL9WO5xipiHTZlSzBm7WLT627TqC/uVRd0HKmq8NXyebnNYxDoBi7wt8eTWrUrKXCOVaFq9x1kgag==} + + handlebars@4.7.8: + resolution: {integrity: sha512-vafaFqs8MZkRrSX7sFVUdo3ap/eNiLnb4IakshzvP56X5Nr1iGKAIqdX6tMlm6HcNRIkr6AxO5jFEoJzzpT8aQ==} + engines: {node: '>=0.4.7'} + hasBin: true + + hard-rejection@2.1.0: + resolution: {integrity: sha512-VIZB+ibDhx7ObhAe7OVtoEbuP4h/MuOTHJ+J8h/eBXotJYl0fBgR72xDFCKgIh22OJZIOVNxBMWuhAr10r8HdA==} + engines: {node: '>=6'} + + hardhat-abi-exporter@2.10.1: + resolution: {integrity: sha512-X8GRxUTtebMAd2k4fcPyVnCdPa6dYK4lBsrwzKP5yiSq4i+WadWPIumaLfce53TUf/o2TnLpLOduyO1ylE2NHQ==} + engines: {node: '>=14.14.0'} + peerDependencies: + hardhat: ^2.0.0 + + hardhat-deploy@0.11.45: + resolution: {integrity: sha512-aC8UNaq3JcORnEUIwV945iJuvBwi65tjHVDU3v6mOcqik7WAzHVCJ7cwmkkipsHrWysrB5YvGF1q9S1vIph83w==} + + hardhat-gas-reporter@1.0.10: + resolution: {integrity: sha512-02N4+So/fZrzJ88ci54GqwVA3Zrf0C9duuTyGt0CFRIh/CdNwbnTgkXkRfojOMLBQ+6t+lBIkgbsOtqMvNwikA==} + peerDependencies: + hardhat: ^2.0.2 + + hardhat-preprocessor@0.1.5: + resolution: {integrity: sha512-j8m44mmPxpxAAd0G8fPHRHOas/INZdzptSur0TNJvMEGcFdLDhbHHxBcqZVQ/bmiW42q4gC60AP4CXn9EF018g==} + peerDependencies: + hardhat: ^2.0.5 + + hardhat@2.22.10: + resolution: {integrity: sha512-JRUDdiystjniAvBGFmJRsiIZSOP2/6s++8xRDe3TzLeQXlWWHsXBrd9wd3JWFyKXvgMqMeLL5Sz/oNxXKYw9vg==} + hasBin: true + peerDependencies: + ts-node: '*' + typescript: '*' + peerDependenciesMeta: + ts-node: + optional: true + typescript: + optional: true + + has-flag@1.0.0: + resolution: {integrity: sha512-DyYHfIYwAJmjAjSSPKANxI8bFY9YtFrgkAfinBojQ8YJTOuOuav64tMUJv584SES4xl74PmuaevIyaLESHdTAA==} + engines: {node: '>=0.10.0'} + + has-flag@3.0.0: + resolution: {integrity: sha512-sKJf1+ceQBr4SMkvQnBDNDtf4TXpVhVGateu0t918bl30FnbE2m4vNLX+VWe/dpjlb+HugGYzW7uQXH98HPEYw==} + engines: {node: '>=4'} + + has-flag@4.0.0: + resolution: {integrity: sha512-EykJT/Q1KjTWctppgIAgfSO0tKVuZUjhgMr17kqTumMl6Afv3EISleU7qZUzoXDFTAHTDC4NOoG/ZxU3EvlMPQ==} + engines: {node: '>=8'} + + has-property-descriptors@1.0.2: + resolution: {integrity: sha512-55JNKuIW+vq4Ke1BjOTjM2YctQIvCT7GFzHwmfZPGo5wnrgkid0YQtnAleFSqumZm4az3n2BS+erby5ipJdgrg==} + + has-proto@1.0.3: + resolution: {integrity: sha512-SJ1amZAJUiZS+PhsVLf5tGydlaVB8EdFpaSO4gmiUKUOxk8qzn5AIy4ZeJUmh22znIdk/uMAUT2pl3FxzVUH+Q==} + engines: {node: '>= 0.4'} + + has-symbols@1.0.3: + resolution: {integrity: sha512-l3LCuF6MgDNwTDKkdYGEihYjt5pRPbEg46rtlmnSPlUbgmB8LOIrKJbYYFBSbnPaJexMKtiPO8hmeRjRz2Td+A==} + engines: {node: '>= 0.4'} + + hash-base@3.1.0: + resolution: {integrity: sha512-1nmYp/rhMDiE7AYkDw+lLwlAzz0AntGIe51F3RfFfEqyQ3feY2eI/NcwC6umIQVOASPMsWJLJScWKSSvzL9IVA==} + engines: {node: '>=4'} + + hash.js@1.1.7: + resolution: {integrity: sha512-taOaskGt4z4SOANNseOviYDvjEJinIkRgmp7LbKP2YTTmVxWBl87s/uzK9r+44BclBSp2X7K1hqeNfz9JbBeXA==} + + hasown@2.0.2: + resolution: {integrity: sha512-0hJU9SCPvmMzIBdZFqNPXWa6dqh7WdH0cII9y+CyS8rG3nL48Bclra9HmKhVVUHyPWNH5Y7xDwAB7bfgSjkUMQ==} + engines: {node: '>= 0.4'} + + he@1.2.0: + resolution: {integrity: sha512-F/1DnUGPopORZi0ni+CvrCgHQ5FyEAHRLSApuYWMmrbSwoN2Mn/7k+Gl38gJnR7yyDZk6WLXwiGod1JOWNDKGw==} + hasBin: true + + heap@0.2.7: + resolution: {integrity: sha512-2bsegYkkHO+h/9MGbn6KWcE45cHZgPANo5LXF7EvWdT0yT2EguSVO1nDgU5c8+ZOPwp2vMNa7YFsJhVcDR9Sdg==} + + hmac-drbg@1.0.1: + resolution: {integrity: sha512-Tti3gMqLdZfhOQY1Mzf/AanLiqh1WTiJgEj26ZuYQ9fbkLomzGchCws4FyrSd4VkpBfiNhaE1On+lOz894jvXg==} + + homedir-polyfill@1.0.3: + resolution: {integrity: sha512-eSmmWE5bZTK2Nou4g0AI3zZ9rswp7GRKoKXS1BLUkvPviOqs4YTN1djQIqrXy9k5gEtdLPy86JjRwsNM9tnDcA==} + engines: {node: '>=0.10.0'} + + hosted-git-info@2.8.9: + resolution: {integrity: sha512-mxIDAb9Lsm6DoOJ7xH+5+X4y1LU/4Hi50L9C5sIswK3JzULS4bwk1FvjdBgvYR4bzT4tuUQiC15FE2f5HbLvYw==} + + hosted-git-info@4.1.0: + resolution: {integrity: sha512-kyCuEOWjJqZuDbRHzL8V93NzQhwIB71oFWSyzVo+KPZI+pnQPPxucdkrOZvkLRnrf5URsQM+IJ09Dw29cRALIA==} + engines: {node: '>=10'} + + http-basic@8.1.3: + resolution: {integrity: sha512-/EcDMwJZh3mABI2NhGfHOGOeOZITqfkEO4p/xK+l3NpyncIHUQBoMvCSF/b5GqvKtySC2srL/GGG3+EtlqlmCw==} + engines: {node: '>=6.0.0'} + + http-errors@2.0.0: + resolution: {integrity: sha512-FtwrG/euBzaEjYeRqOgly7G0qviiXoJWnvEH2Z1plBdXgbyjv34pHTSb9zoeHMyDy33+DWy5Wt9Wo+TURtOYSQ==} + engines: {node: '>= 0.8'} + + http-response-object@3.0.2: + resolution: {integrity: sha512-bqX0XTF6fnXSQcEJ2Iuyr75yVakyjIDCqroJQ/aHfSdlM743Cwqoi2nDYMzLGWUcuTWGWy8AAvOKXTfiv6q9RA==} + + https-proxy-agent@5.0.1: + resolution: {integrity: sha512-dFcAjpTQFgoLMzC2VwU+C/CbS7uRL0lWmxDITmqm7C+7F0Odmj6s9l6alZc6AELXhrnggM2CeWSXHGOdX2YtwA==} + engines: {node: '>= 6'} + + human-signals@2.1.0: + resolution: {integrity: sha512-B4FFZ6q/T2jhhksgkbEW3HBvWIfDW85snkQgawt07S7J5QXTk6BkNV+0yAeZrM5QpMAdYlocGoljn0sJ/WQkFw==} + engines: {node: '>=10.17.0'} + + human-signals@4.3.1: + resolution: {integrity: sha512-nZXjEF2nbo7lIw3mgYjItAfgQXog3OjJogSbKa2CQIIvSGWcKgeJnQlNXip6NglNzYH45nSRiEVimMvYL8DDqQ==} + engines: {node: '>=14.18.0'} + + husky@8.0.3: + resolution: {integrity: sha512-+dQSyqPh4x1hlO1swXBiNb2HzTDN1I2IGLQx1GrBuiqFJfoMrnZWwVmatvSiO+Iz8fBUnf+lekwNo4c2LlXItg==} + engines: {node: '>=14'} + hasBin: true + + iconv-lite@0.4.24: + resolution: {integrity: sha512-v3MXnZAcvnywkTUEZomIActle7RXXeedOR31wwl7VlyoXO4Qi9arvSenNQWne1TcRwhCL1HwLI21bEqdpj8/rA==} + engines: {node: '>=0.10.0'} + + ieee754@1.2.1: + resolution: {integrity: sha512-dcyqhDvX1C46lXZcVqCpK+FtMRQVdIMN6/Df5js2zouUsqG7I6sFxitIC+7KYK29KdXOLHdu9zL4sFnoVQnqaA==} + + ignore@5.3.2: + resolution: {integrity: sha512-hsBTNUqQTDwkWtcdYI2i06Y/nUBEsNEDJKjWdigLvegy8kDuJAS8uRlpkkcQpyEXL0Z/pjDy5HBmMjRCJ2gq+g==} + engines: {node: '>= 4'} + + immer@10.0.2: + resolution: {integrity: sha512-Rx3CqeqQ19sxUtYV9CU911Vhy8/721wRFnJv3REVGWUmoAcIwzifTsdmJte/MV+0/XpM35LZdQMBGkRIoLPwQA==} + + immutable@4.3.7: + resolution: {integrity: sha512-1hqclzwYwjRDFLjcFxOM5AYkkG0rpFPpr1RLPMEuGczoS7YA8gLhy8SWXYRAA/XwfEHpfo3cw5JGioS32fnMRw==} + + import-fresh@3.3.0: + resolution: {integrity: sha512-veYYhQa+D1QBKznvhUHxb8faxlrwUnxseDAbAp457E0wLNio2bOSKnjYDhMj+YiAq61xrMGhQk9iXVk5FzgQMw==} + engines: {node: '>=6'} + + import-meta-resolve@4.1.0: + resolution: {integrity: sha512-I6fiaX09Xivtk+THaMfAwnA3MVA5Big1WHF1Dfx9hFuvNIWpXnorlkzhcQf6ehrqQiiZECRt1poOAkPmer3ruw==} + + imul@1.0.1: + resolution: {integrity: sha512-WFAgfwPLAjU66EKt6vRdTlKj4nAgIDQzh29JonLa4Bqtl6D8JrIMvWjCnx7xEjVNmP3U0fM5o8ZObk7d0f62bA==} + engines: {node: '>=0.10.0'} + + imurmurhash@0.1.4: + resolution: {integrity: sha512-JmXMZ6wuvDmLiHEml9ykzqO6lwFbof0GG4IkcGaENdCRDDmMVnny7s5HsIgHCbaq0w2MyPhDqkhTUgS2LU2PHA==} + engines: {node: '>=0.8.19'} + + indent-string@4.0.0: + resolution: {integrity: sha512-EdDDZu4A2OyIK7Lr/2zG+w5jmbuk1DVBnEwREQvBzspBJkCEbRa8GxU1lghYcaGJCnRWibjDXlq779X1/y5xwg==} + engines: {node: '>=8'} + + inflight@1.0.6: + resolution: {integrity: sha512-k92I/b08q4wvFscXCLvqfsHCrjrF7yiXsQuIVvVE7N82W3+aqpzuUdBbfhWcy/FZR3/4IgflMgKLOsvPDrGCJA==} + deprecated: This module is not supported, and leaks memory. Do not use it. Check out lru-cache if you want a good and tested way to coalesce async requests by a key value, which is much more comprehensive and powerful. + + inherits@2.0.4: + resolution: {integrity: sha512-k/vGaX4/Yla3WzyMCvTQOXYeIHvqOKtnqBduzTHpzpQZzAskKMhZ2K+EnBiSM9zGSoIFeMpXKxa4dYeZIQqewQ==} + + ini@1.3.8: + resolution: {integrity: sha512-JV/yugV2uzW5iMRSiZAyDtQd+nxtUnjeLt0acNdw98kKLrvuRVyB80tsREOE7yvGVgalhZ6RNXCmEHkUKBKxew==} + + ini@4.1.1: + resolution: {integrity: sha512-QQnnxNyfvmHFIsj7gkPcYymR8Jdw/o7mp5ZFihxn6h8Ci6fh3Dx4E1gPjpQEpIuPo9XVNY/ZUwh4BPMjGyL01g==} + engines: {node: ^14.17.0 || ^16.13.0 || >=18.0.0} + + inquirer@8.2.5: + resolution: {integrity: sha512-QAgPDQMEgrDssk1XiwwHoOGYF9BAbUcc1+j+FhEvaOt8/cKRqyLn0U5qA6F74fGhTMGxf92pOvPBeh29jQJDTQ==} + engines: {node: '>=12.0.0'} + + interpret@1.4.0: + resolution: {integrity: sha512-agE4QfB2Lkp9uICn7BAqoscw4SZP9kTE2hxiFI3jBPmXJfdqiahTbUuKGsMoN2GtqL9AxhYioAcVvgsb1HvRbA==} + engines: {node: '>= 0.10'} + + io-ts@1.10.4: + resolution: {integrity: sha512-b23PteSnYXSONJ6JQXRAlvJhuw8KOtkqa87W4wDtvMrud/DTJd5X+NpOOI+O/zZwVq6v0VLAaJ+1EDViKEuN9g==} + + is-arrayish@0.2.1: + resolution: {integrity: sha512-zz06S8t0ozoDXMG+ube26zeCTNXcKIPJZJi8hBrF4idCLms4CG9QtK7qBl1boi5ODzFpjswb5JPmHCbMpjaYzg==} + + is-binary-path@2.1.0: + resolution: {integrity: sha512-ZMERYes6pDydyuGidse7OsHxtbI7WVeUEozgR/g7rd0xUimYNlvZRE/K2MgZTjWy725IfelLeVcEM97mmtRGXw==} + engines: {node: '>=8'} + + is-builtin-module@3.2.1: + resolution: {integrity: sha512-BSLE3HnV2syZ0FK0iMA/yUGplUeMmNz4AW5fnTunbCIqZi4vG3WjJT9FHMy5D69xmAYBHXQhJdALdpwVxV501A==} + engines: {node: '>=6'} + + is-core-module@2.15.1: + resolution: {integrity: sha512-z0vtXSwucUJtANQWldhbtbt7BnL0vxiFjIdDLAatwhDYty2bad6s+rijD6Ri4YuYJubLzIJLUidCh09e1djEVQ==} + engines: {node: '>= 0.4'} + + is-docker@2.2.1: + resolution: {integrity: sha512-F+i2BKsFrH66iaUFc0woD8sLy8getkwTwtOBjvs56Cx4CgJDeKQeqfz8wAYiSb8JOprWhHH5p77PbmYCvvUuXQ==} + engines: {node: '>=8'} + hasBin: true + + is-extglob@2.1.1: + resolution: {integrity: sha512-SbKbANkN603Vi4jEZv49LeVJMn4yGwsbzZworEoyEiutsN3nJYdbO36zfhGJ6QEDpOZIFkDtnq5JRxmvl3jsoQ==} + engines: {node: '>=0.10.0'} + + is-fullwidth-code-point@2.0.0: + resolution: {integrity: sha512-VHskAKYM8RfSFXwee5t5cbN5PZeq1Wrh6qd5bkyiXIf6UQcN6w/A0eXM9r6t8d+GYOh+o6ZhiEnb88LN/Y8m2w==} + engines: {node: '>=4'} + + is-fullwidth-code-point@3.0.0: + resolution: {integrity: sha512-zymm5+u+sCsSWyD9qNaejV3DFvhCKclKdizYaJUuHA83RLjb7nSuGnddCHGv0hk+KY7BMAlsWeK4Ueg6EV6XQg==} + engines: {node: '>=8'} + + is-fullwidth-code-point@4.0.0: + resolution: {integrity: sha512-O4L094N2/dZ7xqVdrXhh9r1KODPJpFms8B5sGdJLPy664AgvXsreZUyCQQNItZRDlYug4xStLjNp/sz3HvBowQ==} + engines: {node: '>=12'} + + is-glob@4.0.3: + resolution: {integrity: sha512-xelSayHH36ZgE7ZWhli7pW34hNbNl8Ojv5KVmkJD4hBdD3th8Tfk9vYasLM+mXWOZhFkgZfxhLSnrwRr4elSSg==} + engines: {node: '>=0.10.0'} + + is-hex-prefixed@1.0.0: + resolution: {integrity: sha512-WvtOiug1VFrE9v1Cydwm+FnXd3+w9GaeVUss5W4v/SLy3UW00vP+6iNF2SdnfiBoLy4bTqVdkftNGTUeOFVsbA==} + engines: {node: '>=6.5.0', npm: '>=3'} + + is-interactive@1.0.0: + resolution: {integrity: sha512-2HvIEKRoqS62guEC+qBjpvRubdX910WCMuJTZ+I9yvqKU2/12eSL549HMwtabb4oupdj2sMP50k+XJfB/8JE6w==} + engines: {node: '>=8'} + + is-module@1.0.0: + resolution: {integrity: sha512-51ypPSPCoTEIN9dy5Oy+h4pShgJmPCygKfyRCISBI+JoWT/2oJvK8QPxmwv7b/p239jXrm9M1mlQbyKJ5A152g==} + + is-number@7.0.0: + resolution: {integrity: sha512-41Cifkg6e8TylSpdtTpeLVMqvSBEVzTttHvERD741+pnZ8ANv0004MRL43QKPDlK9cGvNp6NZWZUBlbGXYxxng==} + engines: {node: '>=0.12.0'} + + is-obj@2.0.0: + resolution: {integrity: sha512-drqDG3cbczxxEJRoOXcOjtdp1J/lyp1mNn0xaznRs8+muBhgQcrnbspox5X5fOw0HnMnbfDzvnEMEtqDEJEo8w==} + engines: {node: '>=8'} + + is-path-inside@3.0.3: + resolution: {integrity: sha512-Fd4gABb+ycGAmKou8eMftCupSir5lRxqf4aD/vd0cD2qc4HL07OjCeuHMr8Ro4CoMaeCKDB0/ECBOVWjTwUvPQ==} + engines: {node: '>=8'} + + is-plain-obj@1.1.0: + resolution: {integrity: sha512-yvkRyxmFKEOQ4pNXCmJG5AEQNlXJS5LaONXo5/cLdTZdWvsZ1ioJEonLGAosKlMWE8lwUy/bJzMjcw8az73+Fg==} + engines: {node: '>=0.10.0'} + + is-plain-obj@2.1.0: + resolution: {integrity: sha512-YWnfyRwxL/+SsrWYfOpUtz5b3YD+nyfkHvjbcanzk8zgyO4ASD67uVMRt8k5bM4lLMDnXfriRhOpemw+NfT1eA==} + engines: {node: '>=8'} + + is-reference@1.2.1: + resolution: {integrity: sha512-U82MsXXiFIrjCK4otLT+o2NA2Cd2g5MLoOVXUZjIOhLurrRxpEXzI8O0KZHr3IjLvlAH1kTPYSuqer5T9ZVBKQ==} + + is-stream@2.0.1: + resolution: {integrity: sha512-hFoiJiTl63nn+kstHGBtewWSKnQLpyb155KHheA1l39uvtO9nWIop1p3udqPcUd/xbF1VLMO4n7OI6p7RbngDg==} + engines: {node: '>=8'} + + is-stream@3.0.0: + resolution: {integrity: sha512-LnQR4bZ9IADDRSkvpqMGvt/tEJWclzklNgSw48V5EAaAeDd6qGvN8ei6k5p0tvxSR171VmGyHuTiAOfxAbr8kA==} + engines: {node: ^12.20.0 || ^14.13.1 || >=16.0.0} + + is-text-path@1.0.1: + resolution: {integrity: sha512-xFuJpne9oFz5qDaodwmmG08e3CawH/2ZV8Qqza1Ko7Sk8POWbkRdwIoAWVhqvq0XeUzANEhKo2n0IXUGBm7A/w==} + engines: {node: '>=0.10.0'} + + is-unicode-supported@0.1.0: + resolution: {integrity: sha512-knxG2q4UC3u8stRGyAVJCOdxFmv5DZiRcdlIaAQXAbSfJya+OhopNotLQrstBhququ4ZpuKbDc/8S6mgXgPFPw==} + engines: {node: '>=10'} + + is-utf8@0.2.1: + resolution: {integrity: sha512-rMYPYvCzsXywIsldgLaSoPlw5PfoB/ssr7hY4pLfcodrA5M/eArza1a9VmTiNIBNMjOGr1Ow9mTyU2o69U6U9Q==} + + is-windows@1.0.2: + resolution: {integrity: sha512-eXK1UInq2bPmjyX6e3VHIzMLobc4J94i4AWn+Hpq3OU5KkrRC96OAcR3PRJ/pGu6m8TRnBHP9dkXQVsT/COVIA==} + engines: {node: '>=0.10.0'} + + is-wsl@2.2.0: + resolution: {integrity: sha512-fKzAra0rGJUUBwGBgNkHZuToZcn+TtXHpeCgmkMJMMYx1sQDYaCSyjJBSCa2nH1DGm7s3n1oBnohoVTBaN7Lww==} + engines: {node: '>=8'} + + isarray@1.0.0: + resolution: {integrity: sha512-VLghIWNM6ELQzo7zwmcg0NmTVyWKYjvIeM83yjp0wRDTmUnrM678fQbcKBo6n2CJEF0szoG//ytg+TKla89ALQ==} + + isexe@2.0.0: + resolution: {integrity: sha512-RHxMLp9lnKHGHRng9QFhRCMbYAcVpn69smSGcq3f36xjgVVWThj4qqLbTLlq7Ssj8B+fIQ1EuCEGI2lKsyQeIw==} + + isomorphic-unfetch@3.1.0: + resolution: {integrity: sha512-geDJjpoZ8N0kWexiwkX8F9NkTsXhetLPVbZFQ+JTW239QNOwvB0gniuR1Wc6f0AMTn7/mFGyXvHTifrCp/GH8Q==} + + isows@1.0.4: + resolution: {integrity: sha512-hEzjY+x9u9hPmBom9IIAqdJCwNLax+xrPb51vEPpERoFlIxgmZcHzsT5jKG06nvInKOBGvReAVz80Umed5CczQ==} + peerDependencies: + ws: '*' + + jackspeak@3.4.3: + resolution: {integrity: sha512-OGlZQpz2yfahA/Rd1Y8Cd9SIEsqvXkLVoSw/cgwhnhFMDbsQFeZYoJJ7bIZBS9BcamUW96asq/npPWugM+RQBw==} + + javascript-natural-sort@0.7.1: + resolution: {integrity: sha512-nO6jcEfZWQXDhOiBtG2KvKyEptz7RVbpGP4vTD2hLBdmNQSsCiicO2Ioinv6UI4y9ukqnBpy+XZ9H6uLNgJTlw==} + + jiti@1.21.6: + resolution: {integrity: sha512-2yTgeWTWzMWkHu6Jp9NKgePDaYHbntiwvYuuJLbbN9vl7DC9DvXKOB2BC3ZZ92D3cvV/aflH0osDfwpHepQ53w==} + hasBin: true + + js-cookie@2.2.1: + resolution: {integrity: sha512-HvdH2LzI/EAZcUwA8+0nKNtWHqS+ZmijLA30RwZA0bo7ToCckjK5MkGhjED9KoRcXO6BaGI3I9UIzSA1FKFPOQ==} + + js-sha3@0.8.0: + resolution: {integrity: sha512-gF1cRrHhIzNfToc802P800N8PpXS+evLLXfsVpowqmAFR9uwbi89WvXg2QspOmXL8QL86J4T1EpFu+yUkwJY3Q==} + + js-tokens@4.0.0: + resolution: {integrity: sha512-RdJUflcE3cUzKiMqQgsCu06FPu9UdIJO0beYbPhHN4k6apgJtifcoCtT9bcxOpYBtpD2kCM6Sbzg4CausW/PKQ==} + + js-yaml@3.14.1: + resolution: {integrity: sha512-okMH7OXXJ7YrN9Ok3/SXrnu4iX9yOk+25nqX4imS2npuvTYDmo/QEZoqwZkYaIDk3jVvBOTOIEgEhaLOynBS9g==} + hasBin: true + + js-yaml@4.1.0: + resolution: {integrity: sha512-wpxZs9NoxZaJESJGIZTyDEaYpl0FKSA+FB9aJiyemKhMwkxQg63h4T1KJgUGHpTqPDNRcmmYLugrRjJlBtWvRA==} + hasBin: true + + jsesc@2.5.2: + resolution: {integrity: sha512-OYu7XEzjkCQ3C5Ps3QIZsQfNpqoJyZZA99wd9aWd05NCtC5pWOkShK2mkL6HXQR6/Cy2lbNdPlZBpuQHXE63gA==} + engines: {node: '>=4'} + hasBin: true + + json-buffer@3.0.1: + resolution: {integrity: sha512-4bV5BfR2mqfQTJm+V5tPPdf+ZpuhiIvTuAB5g8kcrXOZpTT/QwwVRWBywX1ozr6lEuPdbHxwaJlm9G6mI2sfSQ==} + + json-parse-better-errors@1.0.2: + resolution: {integrity: sha512-mrqyZKfX5EhL7hvqcV6WG1yYjnjeuYDzDhhcAAUrq8Po85NBQBJP+ZDUT75qZQ98IkUoBqdkExkukOU7Ts2wrw==} + + json-parse-even-better-errors@2.3.1: + resolution: {integrity: sha512-xyFwyhro/JEof6Ghe2iz2NcXoj2sloNsWr/XsERDK/oiPCfaNhl5ONfp+jQdAZRQQ0IJWNzH9zIZF7li91kh2w==} + + json-schema-traverse@0.4.1: + resolution: {integrity: sha512-xbbCH5dCYU5T8LcEhhuh7HJ88HXuW3qsI3Y0zOZFKfZEHcpWiHU/Jxzk629Brsab/mMiHQti9wMP+845RPe3Vg==} + + json-schema-traverse@1.0.0: + resolution: {integrity: sha512-NM8/P9n3XjXhIZn1lLhkFaACTOURQXjWhV4BA/RnOv8xvgqtqpAX9IO4mRQxSx1Rlo4tqzeqb0sOlruaOy3dug==} + + json-stable-stringify-without-jsonify@1.0.1: + resolution: {integrity: sha512-Bdboy+l7tA3OGW6FjyFHWkP5LuByj1Tk33Ljyq0axyzdk9//JSi2u3fP1QSmd1KNwq6VOKYGlAu87CisVir6Pw==} + + json-stringify-safe@5.0.1: + resolution: {integrity: sha512-ZClg6AaYvamvYEE82d3Iyd3vSSIjQ+odgjaTzRuO3s7toCdFKczob2i0zCh7JE8kWn17yvAWhUVxvqGwUalsRA==} + + json5@2.2.3: + resolution: {integrity: sha512-XmOWe7eyHYH14cLdVPoyg+GOH3rYX++KpzrylJwSW98t3Nk+U8XOl8FWKOgwtzdb8lXGf6zYwDUzeHMWfxasyg==} + engines: {node: '>=6'} + hasBin: true + + jsonfile@4.0.0: + resolution: {integrity: sha512-m6F1R3z8jjlf2imQHS2Qez5sjKWQzbuuhuJ/FKYFRZvPE3PuHcSMVZzfsLhGVOkfd20obL5SWEBew5ShlquNxg==} + + jsonfile@6.1.0: + resolution: {integrity: sha512-5dgndWOriYSm5cnYaJNhalLNDKOqFwyDB/rr1E9ZsGciGvKPs8R2xYGCacuf3z6K1YKDz182fd+fY3cn3pMqXQ==} + + jsonparse@1.3.1: + resolution: {integrity: sha512-POQXvpdL69+CluYsillJ7SUhKvytYjW9vG/GKpnf+xP8UWgYEM/RaMzHHofbALDiKbbP1W8UEYmgGl39WkPZsg==} + engines: {'0': node >= 0.2.0} + + jsonschema@1.4.1: + resolution: {integrity: sha512-S6cATIPVv1z0IlxdN+zUk5EPjkGCdnhN4wVSBlvoUO1tOLJootbo9CquNJmbIh4yikWHiUedhRYrNPn1arpEmQ==} + + keccak@3.0.4: + resolution: {integrity: sha512-3vKuW0jV8J3XNTzvfyicFR5qvxrSAGl7KIhvgOu5cmWwM7tZRj3fMbj/pfIf4be7aznbc+prBWGjywox/g2Y6Q==} + engines: {node: '>=10.0.0'} + + keyv@4.5.4: + resolution: {integrity: sha512-oxVHkHR/EJf2CNXnWxRLW6mg7JyCCUcG0DtEGmL2ctUo1PNTin1PUil+r/+4r5MpVgC/fn1kjsx7mjSujKqIpw==} + + kind-of@6.0.3: + resolution: {integrity: sha512-dcS1ul+9tmeD95T+x28/ehLgd9mENa3LsvDTtzm3vyBEO7RPptvAD+t44WVXaUjTBRcrpFeFlC8WCruUR456hw==} + engines: {node: '>=0.10.0'} + + kleur@3.0.3: + resolution: {integrity: sha512-eTIzlVOSUR+JxdDFepEYcBMtZ9Qqdef+rnzWdRZuMbOywu5tO2w2N7rqjoANZ5k9vywhL6Br1VRjUIgTQx4E8w==} + engines: {node: '>=6'} + + levn@0.3.0: + resolution: {integrity: sha512-0OO4y2iOHix2W6ujICbKIaEQXvFQHue65vUG3pb5EUomzPI90z9hsA1VsO/dbIIpC53J8gxM9Q4Oho0jrCM/yA==} + engines: {node: '>= 0.8.0'} + + levn@0.4.1: + resolution: {integrity: sha512-+bT2uH4E5LGE7h/n3evcS/sQlJXCpIp6ym8OWJ5eV6+67Dsql/LaaT7qJBAt2rzfoa/5QBGBhxDix1dMt2kQKQ==} + engines: {node: '>= 0.8.0'} + + lilconfig@2.1.0: + resolution: {integrity: sha512-utWOt/GHzuUxnLKxB6dk81RoOeoNeHgbrXiuGk4yyF5qlRz+iIVWu56E2fqGHFrXz0QNUhLB/8nKqvRH66JKGQ==} + engines: {node: '>=10'} + + lines-and-columns@1.2.4: + resolution: {integrity: sha512-7ylylesZQ/PV29jhEDl3Ufjo6ZX7gCqJr5F7PKrqc93v7fzSymt1BpwEU8nAUXs8qzzvqhbjhK5QZg6Mt/HkBg==} + + lint-staged@13.3.0: + resolution: {integrity: sha512-mPRtrYnipYYv1FEE134ufbWpeggNTo+O/UPzngoaKzbzHAthvR55am+8GfHTnqNRQVRRrYQLGW9ZyUoD7DsBHQ==} + engines: {node: ^16.14.0 || >=18.0.0} + hasBin: true + + listr2@6.6.1: + resolution: {integrity: sha512-+rAXGHh0fkEWdXBmX+L6mmfmXmXvDGEKzkjxO+8mP3+nI/r/CWznVBvsibXdxda9Zz0OW2e2ikphN3OwCT/jSg==} + engines: {node: '>=16.0.0'} + peerDependencies: + enquirer: '>= 2.3.0 < 3' + peerDependenciesMeta: + enquirer: + optional: true + + load-json-file@4.0.0: + resolution: {integrity: sha512-Kx8hMakjX03tiGTLAIdJ+lL0htKnXjEZN6hk/tozf/WOuYGdZBJrZ+rCJRbVCugsjB3jMLn9746NsQIf5VjBMw==} + engines: {node: '>=4'} + + locate-path@2.0.0: + resolution: {integrity: sha512-NCI2kiDkyR7VeEKm27Kda/iQHyKJe1Bu0FlTbYp3CqJu+9IFe9bLyAjMxf5ZDDbEg+iMPzB5zYyUTSm8wVTKmA==} + engines: {node: '>=4'} + + locate-path@5.0.0: + resolution: {integrity: sha512-t7hw9pI+WvuwNJXwk5zVHpyhIqzg2qTlklJOf0mVxGSbe3Fp2VieZcduNYjaLDoy6p9uGpQEGWG87WpMKlNq8g==} + engines: {node: '>=8'} + + locate-path@6.0.0: + resolution: {integrity: sha512-iPZK6eYjbxRu3uB4/WZ3EsEIMJFMqAoopl3R+zuq0UjcAm/MO6KCweDgPfP3elTztoKP3KtnVHxTn2NHBSDVUw==} + engines: {node: '>=10'} + + lodash.camelcase@4.3.0: + resolution: {integrity: sha512-TwuEnCnxbc3rAvhf/LbG7tJUDzhqXyFnv3dtzLOPgCG/hODL7WFnsbwktkD7yUV0RrreP/l1PALq/YSg6VvjlA==} + + lodash.clonedeep@4.5.0: + resolution: {integrity: sha512-H5ZhCF25riFd9uB5UCkVKo61m3S/xZk1x4wA6yp/L3RFP6Z/eHH1ymQcGLo7J3GMPfm0V/7m1tryHuGVxpqEBQ==} + + lodash.isequal@4.5.0: + resolution: {integrity: sha512-pDo3lu8Jhfjqls6GkMgpahsF9kCyayhgykjyLMNFTKWrpVdAQtYyB4muAMWozBB4ig/dtWAmsMxLEI8wuz+DYQ==} + + lodash.isfunction@3.0.9: + resolution: {integrity: sha512-AirXNj15uRIMMPihnkInB4i3NHeb4iBtNg9WRWuK2o31S+ePwwNmDPaTL3o7dTJ+VXNZim7rFs4rxN4YU1oUJw==} + + lodash.isplainobject@4.0.6: + resolution: {integrity: sha512-oSXzaWypCMHkPC3NvBEaPHf0KsA5mvPrOPgQWDsbg8n7orZ290M0BmC/jgRZ4vcJ6DTAhjrsSYgdsW/F+MFOBA==} + + lodash.kebabcase@4.1.1: + resolution: {integrity: sha512-N8XRTIMMqqDgSy4VLKPnJ/+hpGZN+PHQiJnSenYqPaVV/NCqEogTnAdZLQiGKhxX+JCs8waWq2t1XHWKOmlY8g==} + + lodash.map@4.6.0: + resolution: {integrity: sha512-worNHGKLDetmcEYDvh2stPCrrQRkP20E4l0iIS7F8EvzMqBBi7ltvFN5m1HvTf1P7Jk1txKhvFcmYsCr8O2F1Q==} + + lodash.memoize@4.1.2: + resolution: {integrity: sha512-t7j+NzmgnQzTAYXcsHYLgimltOV1MXHtlOWf6GjL9Kj8GK5FInw5JotxvbOs+IvV1/Dzo04/fCGfLVs7aXb4Ag==} + + lodash.merge@4.6.2: + resolution: {integrity: sha512-0KpjqXRVvrYyCsX1swR/XTK0va6VQkQM6MNo7PqW77ByjAhoARA8EfrP1N4+KlKj8YS0ZUCtRT/YUuhyYDujIQ==} + + lodash.mergewith@4.6.2: + resolution: {integrity: sha512-GK3g5RPZWTRSeLSpgP8Xhra+pnjBC56q9FZYe1d5RN3TJ35dbkGy3YqBSMbyCrlbi+CM9Z3Jk5yTL7RCsqboyQ==} + + lodash.snakecase@4.1.1: + resolution: {integrity: sha512-QZ1d4xoBHYUeuouhEq3lk3Uq7ldgyFXGBhg04+oRLnIz8o9T65Eh+8YdroUwn846zchkA9yDsDl5CVVaV2nqYw==} + + lodash.startcase@4.4.0: + resolution: {integrity: sha512-+WKqsK294HMSc2jEbNgpHpd0JfIBhp7rEV4aqXWqFr6AlXov+SlcgB1Fv01y2kGe3Gc8nMW7VA0SrGuSkRfIEg==} + + lodash.truncate@4.4.2: + resolution: {integrity: sha512-jttmRe7bRse52OsWIMDLaXxWqRAmtIUccAQ3garviCqJjafXOfNMO0yMfNpdD6zbGaTU0P5Nz7e7gAT6cKmJRw==} + + lodash.uniq@4.5.0: + resolution: {integrity: sha512-xfBaXQd9ryd9dlSDvnvI0lvxfLJlYAZzXomUYzLKtUeOQvOP5piqAWuGtrhWeqaXK9hhoM/iyJc5AV+XfsX3HQ==} + + lodash.upperfirst@4.3.1: + resolution: {integrity: sha512-sReKOYJIJf74dhJONhU4e0/shzi1trVbSWDOhKYE5XV2O+H7Sb2Dihwuc7xWxVl+DgFPyTqIN3zMfT9cq5iWDg==} + + lodash@4.17.21: + resolution: {integrity: sha512-v2kDEe57lecTulaDIuNTPy3Ry4gLGJ6Z1O3vE1krgXZNrsQ+LFTGHVxVjcXPs17LhbZVGedAJv8XZ1tvj5FvSg==} + + log-symbols@4.1.0: + resolution: {integrity: sha512-8XPvpAA8uyhfteu8pIvQxpJZ7SYYdpUivZpGy6sFsBuKRY/7rQGavedeB8aK+Zkyq6upMFVL/9AW6vOYzfRyLg==} + engines: {node: '>=10'} + + log-update@5.0.1: + resolution: {integrity: sha512-5UtUDQ/6edw4ofyljDNcOVJQ4c7OjDro4h3y8e1GQL5iYElYclVHJ3zeWchylvMaKnDbDilC8irOVyexnA/Slw==} + engines: {node: ^12.20.0 || ^14.13.1 || >=16.0.0} + + longest@2.0.1: + resolution: {integrity: sha512-Ajzxb8CM6WAnFjgiloPsI3bF+WCxcvhdIG3KNA2KN962+tdBsHcuQ4k4qX/EcS/2CRkcc0iAkR956Nib6aXU/Q==} + engines: {node: '>=0.10.0'} + + loupe@2.3.7: + resolution: {integrity: sha512-zSMINGVYkdpYSOBmLi0D1Uo7JU9nVdQKrHxC8eYlV+9YKK9WePqAlL7lSlorG/U2Fw1w0hTBmaa/jrQ3UbPHtA==} + + lru-cache@10.4.3: + resolution: {integrity: sha512-JNAzZcXrCt42VGLuYz0zfAzDfAvJWW6AfYlDBQyDV5DClI2m5sAmK+OIO7s59XfsRsWHp02jAJrRadPRGTt6SQ==} + + lru-cache@5.1.1: + resolution: {integrity: sha512-KpNARQA3Iwv+jTA0utUVVbrh+Jlrr1Fv0e56GGzAFOXN7dk/FviaDW8LHmK52DlcH4WP2n6gI8vN1aesBFgo9w==} + + lru-cache@6.0.0: + resolution: {integrity: sha512-Jo6dJ04CmSjuznwJSS3pUeWmd/H0ffTlkXXgwZi+eq1UCmqQwCh+eLsYOYCwY991i2Fah4h1BEMCx4qThGbsiA==} + engines: {node: '>=10'} + + lru_map@0.3.3: + resolution: {integrity: sha512-Pn9cox5CsMYngeDbmChANltQl+5pi6XmTrraMSzhPmMBbmgcxmqWry0U3PGapCU1yB4/LqCcom7qhHZiF/jGfQ==} + + magic-string@0.25.9: + resolution: {integrity: sha512-RmF0AsMzgt25qzqqLc1+MbHmhdx0ojF2Fvs4XnOqz2ZOBXzzkEwc/dJQZCYHAn7v1jbVOjAZfK8msRn4BxO4VQ==} + + magic-string@0.27.0: + resolution: {integrity: sha512-8UnnX2PeRAPZuN12svgR9j7M1uWMovg/CEnIwIG0LFkXSJJe4PdfUGiTGl8V9bsBHFUtfVINcSyYxd7q+kx9fA==} + engines: {node: '>=12'} + + magic-string@0.30.11: + resolution: {integrity: sha512-+Wri9p0QHMy+545hKww7YAu5NyzF8iomPL/RQazugQ9+Ez4Ic3mERMd8ZTX5rfK944j+560ZJi8iAwgak1Ac7A==} + + make-error@1.3.6: + resolution: {integrity: sha512-s8UhlNe7vPKomQhC1qFelMokr/Sc3AgNbso3n74mVPA5LTZwkB9NlXf4XPamLxJE8h0gh73rM94xvwRT2CVInw==} + + map-obj@1.0.1: + resolution: {integrity: sha512-7N/q3lyZ+LVCp7PzuxrJr4KMbBE2hW7BT7YNia330OFxIf4d3r5zVpicP2650l7CPN6RM9zOJRl3NGpqSiw3Eg==} + engines: {node: '>=0.10.0'} + + map-obj@4.3.0: + resolution: {integrity: sha512-hdN1wVrZbb29eBGiGjJbeP8JbKjq1urkHJ/LIP/NY48MZ1QVXUsQBV1G1zvYFHn1XE06cwjBsOI2K3Ulnj1YXQ==} + engines: {node: '>=8'} + + markdown-table@1.1.3: + resolution: {integrity: sha512-1RUZVgQlpJSPWYbFSpmudq5nHY1doEIv89gBtF0s4gW1GF2XorxcA/70M5vq7rLv0a6mhOUccRsqkwhwLCIQ2Q==} + + match-all@1.2.6: + resolution: {integrity: sha512-0EESkXiTkWzrQQntBu2uzKvLu6vVkUGz40nGPbSZuegcfE5UuSzNjLaIu76zJWuaT/2I3Z/8M06OlUOZLGwLlQ==} + + md5.js@1.3.5: + resolution: {integrity: sha512-xitP+WxNPcTTOgnTJcrhM0xvdPepipPSf3I8EIpGKeFLjt3PlJLIDG3u8EX53ZIubkb+5U2+3rELYpEhHhzdkg==} + + memorystream@0.3.1: + resolution: {integrity: sha512-S3UwM3yj5mtUSEfP41UZmt/0SCoVYUcU1rkXv+BQ5Ig8ndL4sPoJNBUJERafdPb5jjHJGuMgytgKvKIf58XNBw==} + engines: {node: '>= 0.10.0'} + + meow@8.1.2: + resolution: {integrity: sha512-r85E3NdZ+mpYk1C6RjPFEMSE+s1iZMuHtsHAqY0DT3jZczl0diWUZ8g6oU7h0M9cD2EL+PzaYghhCLzR0ZNn5Q==} + engines: {node: '>=10'} + + merge-stream@2.0.0: + resolution: {integrity: sha512-abv/qOcuPfk3URPfDzmZU1LKmuw8kT+0nIHvKrKgFrwifol/doWcdA4ZqsWQ8ENrFKkd67Mfpo/LovbIUsbt3w==} + + merge2@1.4.1: + resolution: {integrity: sha512-8q7VEgMJW4J8tcfVPy8g09NcQwZdbwFEqhe/WZkoIzjn/3TGDwtOCYtXGxA3O8tPzpczCCDgv+P2P5y00ZJOOg==} + engines: {node: '>= 8'} + + merge@2.1.1: + resolution: {integrity: sha512-jz+Cfrg9GWOZbQAnDQ4hlVnQky+341Yk5ru8bZSe6sIDTCIg8n9i/u7hSQGSVOF3C7lH6mGtqjkiT9G4wFLL0w==} + + micro-ftch@0.3.1: + resolution: {integrity: sha512-/0LLxhzP0tfiR5hcQebtudP56gUurs2CLkGarnCiB/OqEyUFQ6U3paQi/tgLv0hBJYt2rnr9MNpxz4fiiugstg==} + + micromatch@4.0.5: + resolution: {integrity: sha512-DMy+ERcEW2q8Z2Po+WNXuw3c5YaUSFjAO5GsJqfEl7UjvtIuFKO6ZrKvcItdy98dwFI2N1tg3zNIdKaQT+aNdA==} + engines: {node: '>=8.6'} + + micromatch@4.0.8: + resolution: {integrity: sha512-PXwfBhYu0hBCPw8Dn0E+WDYb7af3dSLVWKi3HGv84IdF4TyFoC0ysxFd0Goxw7nSv4T/PzEJQxsYsEiFCKo2BA==} + engines: {node: '>=8.6'} + + mime-db@1.52.0: + resolution: {integrity: sha512-sPU4uV7dYlvtWJxwwxHD0PuihVNiE7TyAbQ5SWxDCB9mUYvOgroQOwYQQOKPJ8CIbE+1ETVlOoK1UC2nU3gYvg==} + engines: {node: '>= 0.6'} + + mime-types@2.1.35: + resolution: {integrity: sha512-ZDY+bPm5zTTF+YpCrAU9nK0UgICYPT0QtT1NZWFv4s++TNkcgVaT0g6+4R2uI4MjQjzysHB1zxuWL50hzaeXiw==} + engines: {node: '>= 0.6'} + + mimic-fn@2.1.0: + resolution: {integrity: sha512-OqbOk5oEQeAZ8WXWydlu9HJjz9WVdEIvamMCcXmuqUYjTknH/sqsWvhQ3vgwKFRR1HpjvNBKQ37nbJgYzGqGcg==} + engines: {node: '>=6'} + + mimic-fn@4.0.0: + resolution: {integrity: sha512-vqiC06CuhBTUdZH+RYl8sFrL096vA45Ok5ISO6sE/Mr1jRbGH4Csnhi8f3wKVl7x8mO4Au7Ir9D3Oyv1VYMFJw==} + engines: {node: '>=12'} + + min-indent@1.0.1: + resolution: {integrity: sha512-I9jwMn07Sy/IwOj3zVkVik2JTvgpaykDZEigL6Rx6N9LbMywwUSMtxET+7lVoDLLd3O3IXwJwvuuns8UB/HeAg==} + engines: {node: '>=4'} + + minimalistic-assert@1.0.1: + resolution: {integrity: sha512-UtJcAD4yEaGtjPezWuO9wC4nwUnVH/8/Im3yEHQP4b67cXlD/Qr9hdITCU1xDbSEXg2XKNaP8jsReV7vQd00/A==} + + minimalistic-crypto-utils@1.0.1: + resolution: {integrity: sha512-JIYlbt6g8i5jKfJ3xz7rF0LXmv2TkDxBLUkiBeZ7bAx4GnnNMr8xFpGnOxn6GhTEHx3SjRrZEoU+j04prX1ktg==} + + minimatch@3.1.2: + resolution: {integrity: sha512-J7p63hRiAjw1NDEww1W7i37+ByIrOWO5XQQAzZ3VOcL0PNybwpfmV/N05zFAzwQ9USyEcX6t3UO+K5aqBQOIHw==} + + minimatch@5.1.6: + resolution: {integrity: sha512-lKwV/1brpG6mBUFHtb7NUmtABCb2WZZmm2wNiOA5hAb8VdCS4B3dtMWyvcoViccwAW/COERjXLt0zP1zXUN26g==} + engines: {node: '>=10'} + + minimatch@9.0.5: + resolution: {integrity: sha512-G6T0ZX48xgozx7587koeX9Ys2NYy6Gmv//P89sEte9V9whIapMNF4idKxnW2QtCcLiTWlb/wfCabAtAFWhhBow==} + engines: {node: '>=16 || 14 >=14.17'} + + minimist-options@4.1.0: + resolution: {integrity: sha512-Q4r8ghd80yhO/0j1O3B2BjweX3fiHg9cdOwjJd2J76Q135c+NDxGCqdYKQ1SKBuFfgWbAUzBfvYjPUEeNgqN1A==} + engines: {node: '>= 6'} + + minimist@1.2.7: + resolution: {integrity: sha512-bzfL1YUZsP41gmu/qjrEk0Q6i2ix/cVeAhbCbqH9u3zYutS1cLg00qhrD0M2MVdCcx4Sc0UpP2eBWo9rotpq6g==} + + minimist@1.2.8: + resolution: {integrity: sha512-2yyAR8qBkN3YuheJanUpWC5U3bb5osDywNB8RzDVlDwDHbocAJveqqj1u8+SVD7jkWT4yvsHCpWqqWqAxb0zCA==} + + minipass@7.1.2: + resolution: {integrity: sha512-qOOzS1cBTWYF4BH8fVePDBOO9iptMnGUEZwNc/cMWnTV2nVLZ7VoNWEPHkYczZA0pdoA7dl6e7FL659nX9S2aw==} + engines: {node: '>=16 || 14 >=14.17'} + + mkdirp@0.5.6: + resolution: {integrity: sha512-FP+p8RB8OWpF3YZBCrP5gtADmtXApB5AMLn+vdyA+PyxCjrCs00mjyUozssO33cwDeT3wNGdLxJ5M//YqtHAJw==} + hasBin: true + + mkdirp@1.0.4: + resolution: {integrity: sha512-vVqVZQyf3WLx2Shd0qJ9xuvqgAyKPLAiqITEtqW0oIUjzo3PePDd6fW9iFz30ef7Ysp/oiWqbhszeGWW2T6Gzw==} + engines: {node: '>=10'} + hasBin: true + + mnemonist@0.38.5: + resolution: {integrity: sha512-bZTFT5rrPKtPJxj8KSV0WkPyNxl72vQepqqVUAW2ARUpUSF2qXMB6jZj7hW5/k7C1rtpzqbD/IIbJwLXUjCHeg==} + + mocha@10.7.3: + resolution: {integrity: sha512-uQWxAu44wwiACGqjbPYmjo7Lg8sFrS3dQe7PP2FQI+woptP4vZXSMcfMyFL/e1yFEeEpV4RtyTpZROOKmxis+A==} + engines: {node: '>= 14.0.0'} + hasBin: true + + ms@2.1.2: + resolution: {integrity: sha512-sGkPx+VjMtmA6MX27oA4FBFELFCZZ4S4XqeGOXCv68tT+jb3vk/RyaKWP0PTKyWtmLSM0b+adUTEvbs1PEaH2w==} + + ms@2.1.3: + resolution: {integrity: sha512-6FlzubTLZG3J2a/NVCAleEhjzq5oxgHyaCU9yYXvcLsvoVaHJq/s5xXI6/XXP6tz7R9xAOtHnSO/tXtF3WRTlA==} + + murmur-128@0.2.1: + resolution: {integrity: sha512-WseEgiRkI6aMFBbj8Cg9yBj/y+OdipwVC7zUo3W2W1JAJITwouUOtpqsmGSg67EQmwwSyod7hsVsWY5LsrfQVg==} + + mute-stream@0.0.8: + resolution: {integrity: sha512-nnbWWOkoWyUsTjKrhgD0dcz22mdkSnpYqbEjIm2nhwhuxlSkpywJmBo8h0ZqJdkp73mb90SssHkN4rsRaBAfAA==} + + nanoid@3.3.7: + resolution: {integrity: sha512-eSRppjcPIatRIMC1U6UngP8XFcz8MQWGQdt1MTBQ7NaAmvXDfvNxbvWV3x2y6CdEUciCSsDHDQZbhYaB8QEo2g==} + engines: {node: ^10 || ^12 || ^13.7 || ^14 || >=15.0.1} + hasBin: true + + natural-compare@1.4.0: + resolution: {integrity: sha512-OWND8ei3VtNC9h7V60qff3SVobHr996CTwgxubgyQYEpg290h9J0buyECNNJexkFm5sOajh5G116RYA1c8ZMSw==} + + ndjson@2.0.0: + resolution: {integrity: sha512-nGl7LRGrzugTtaFcJMhLbpzJM6XdivmbkdlaGcrk/LXg2KL/YBC6z1g70xh0/al+oFuVFP8N8kiWRucmeEH/qQ==} + engines: {node: '>=10'} + hasBin: true + + neo-async@2.6.2: + resolution: {integrity: sha512-Yd3UES5mWCSqR+qNT93S3UoYUkqAZ9lLg8a7g9rimsWmYGK8cVToA4/sF3RrshdyV3sAGMXVUmpMYOw+dLpOuw==} + + node-addon-api@2.0.2: + resolution: {integrity: sha512-Ntyt4AIXyaLIuMHF6IOoTakB3K+RWxwtsHNRxllEoA6vPwP9o4866g6YWDLUdnucilZhmkxiHwHr11gAENw+QA==} + + node-emoji@1.11.0: + resolution: {integrity: sha512-wo2DpQkQp7Sjm2A0cq+sN7EHKO6Sl0ctXeBdFZrL9T9+UywORbufTcTZxom8YqpLQt/FqNMUkOpkZrJVYSKD3A==} + + node-fetch@2.7.0: + resolution: {integrity: sha512-c4FRfUm/dbcWZ7U+1Wq0AwCyFL+3nt2bEw05wfxSz+DWpWsitgmSgYmy2dQdWyKC1694ELPqMs/YzUSNozLt8A==} + engines: {node: 4.x || >=6.0.0} + peerDependencies: + encoding: ^0.1.0 + peerDependenciesMeta: + encoding: + optional: true + + node-gyp-build@4.8.2: + resolution: {integrity: sha512-IRUxE4BVsHWXkV/SFOut4qTlagw2aM8T5/vnTsmrHJvVoKueJHRc/JaFND7QDDc61kLYUJ6qlZM3sqTSyx2dTw==} + hasBin: true + + node-releases@2.0.18: + resolution: {integrity: sha512-d9VeXT4SJ7ZeOqGX6R5EM022wpL+eWPooLI+5UpWn2jCT1aosUQEhQP214x33Wkwx3JQMvIm+tIoVOdodFS40g==} + + nofilter@3.1.0: + resolution: {integrity: sha512-l2NNj07e9afPnhAhvgVrCD/oy2Ai1yfLpuo3EpiO1jFTsB4sFz6oIfAfSZyQzVpkZQ9xS8ZS5g1jCBgq4Hwo0g==} + engines: {node: '>=12.19'} + + nopt@3.0.6: + resolution: {integrity: sha512-4GUt3kSEYmk4ITxzB/b9vaIDfUVWN/Ml1Fwl11IlnIG2iaJ9O6WXZ9SrYM9NLI8OCBieN2Y8SWC2oJV0RQ7qYg==} + hasBin: true + + normalize-package-data@2.5.0: + resolution: {integrity: sha512-/5CMN3T0R4XTj4DcGaexo+roZSdSFW/0AOOTROrjxzCG1wrWXEsGbRKevjlIL+ZDE4sZlJr5ED4YW0yqmkK+eA==} + + normalize-package-data@3.0.3: + resolution: {integrity: sha512-p2W1sgqij3zMMyRC067Dg16bfzVH+w7hyegmpIvZ4JNjqtGOVAIvLmjBx3yP7YTe9vKJgkoNOPjwQGogDoMXFA==} + engines: {node: '>=10'} + + normalize-path@3.0.0: + resolution: {integrity: sha512-6eZs5Ls3WtCisHWp9S2GUy8dqkpGi4BVSz3GaqiE6ezub0512ESztXUwUB6C6IKbQkY2Pnb/mD4WYojCRwcwLA==} + engines: {node: '>=0.10.0'} + + npm-run-path@4.0.1: + resolution: {integrity: sha512-S48WzZW777zhNIrn7gxOlISNAqi9ZC/uQFnRdbeIHhZhCA6UqpkOT8T1G7BvfdgP4Er8gF4sUbaS0i7QvIfCWw==} + engines: {node: '>=8'} + + npm-run-path@5.3.0: + resolution: {integrity: sha512-ppwTtiJZq0O/ai0z7yfudtBpWIoxM8yE6nHi1X47eFR2EWORqfbu6CnPlNsjeN683eT0qG6H/Pyf9fCcvjnnnQ==} + engines: {node: ^12.20.0 || ^14.13.1 || >=16.0.0} + + number-to-bn@1.7.0: + resolution: {integrity: sha512-wsJ9gfSz1/s4ZsJN01lyonwuxA1tml6X1yBDnfpMglypcBRFZZkus26EdPSlqS5GJfYddVZa22p3VNb3z5m5Ig==} + engines: {node: '>=6.5.0', npm: '>=3'} + + object-assign@4.1.1: + resolution: {integrity: sha512-rJgTQnkUnH1sFw8yT6VSU3zD3sWmu6sZhIseY8VX+GRu3P6F7Fu+JNDoXfklElbLJSnc3FUQHVe4cU5hj+BcUg==} + engines: {node: '>=0.10.0'} + + object-inspect@1.13.2: + resolution: {integrity: sha512-IRZSRuzJiynemAXPYtPe5BoI/RESNYR7TYm50MC5Mqbd3Jmw5y790sErYw3V6SryFJD64b74qQQs9wn5Bg/k3g==} + engines: {node: '>= 0.4'} + + obliterator@2.0.4: + resolution: {integrity: sha512-lgHwxlxV1qIg1Eap7LgIeoBWIMFibOjbrYPIPJZcI1mmGAI2m3lNYpK12Y+GBdPQ0U1hRwSord7GIaawz962qQ==} + + once@1.4.0: + resolution: {integrity: sha512-lNaJgI+2Q5URQBkccEKHTQOPaXdUxnZZElQTZY0MFUAuaEqe1E+Nyvgdz/aIyNi6Z9MzO5dv1H8n58/GELp3+w==} + + onetime@5.1.2: + resolution: {integrity: sha512-kbpaSSGJTWdAY5KPVeMOKXSrPtr8C8C7wodJbcsd51jRnmD+GZu8Y0VoU6Dm5Z4vWr0Ig/1NKuWRKf7j5aaYSg==} + engines: {node: '>=6'} + + onetime@6.0.0: + resolution: {integrity: sha512-1FlR+gjXK7X+AsAHso35MnyN5KqGwJRi/31ft6x0M194ht7S+rWAvd7PHss9xSKMzE0asv1pyIHaJYq+BbacAQ==} + engines: {node: '>=12'} + + open@8.4.2: + resolution: {integrity: sha512-7x81NCL719oNbsq/3mh+hVrAWmFuEYUqrq/Iw3kUzH8ReypT9QQ0BLoJS7/G9k6N81XjW4qHWtjWwe/9eLy1EQ==} + engines: {node: '>=12'} + + optionator@0.8.3: + resolution: {integrity: sha512-+IW9pACdk3XWmmTXG8m3upGUJst5XRGzxMRjXzAuJ1XnIFNvfhjjIuYkDvysnPQ7qzqVzLt78BCruntqRhWQbA==} + engines: {node: '>= 0.8.0'} + + optionator@0.9.4: + resolution: {integrity: sha512-6IpQ7mKUxRcZNLIObR0hz7lxsapSSIYNZJwXPGeF0mTVqGKFIXj1DQcMoT22S3ROcLyY/rz0PWaWZ9ayWmad9g==} + engines: {node: '>= 0.8.0'} + + ora@5.4.1: + resolution: {integrity: sha512-5b6Y85tPxZZ7QytO+BQzysW31HJku27cRIlkbAXaNx+BdcVi+LlRFmVXzeF6a7JCwJpyw5c4b+YSVImQIrBpuQ==} + engines: {node: '>=10'} + + ordinal@1.0.3: + resolution: {integrity: sha512-cMddMgb2QElm8G7vdaa02jhUNbTSrhsgAGUz1OokD83uJTwSUn+nKoNoKVVaRa08yF6sgfO7Maou1+bgLd9rdQ==} + + os-tmpdir@1.0.2: + resolution: {integrity: sha512-D2FR03Vir7FIu45XBY20mTb+/ZSWB00sjU9jdQXt83gDrI4Ztz5Fs7/yy74g2N5SVQY4xY1qDr4rNddwYRVX0g==} + engines: {node: '>=0.10.0'} + + p-limit@1.3.0: + resolution: {integrity: sha512-vvcXsLAJ9Dr5rQOPk7toZQZJApBl2K4J6dANSsEuh6QI41JYcsS/qhTGa9ErIUUgK3WNQoJYvylxvjqmiqEA9Q==} + engines: {node: '>=4'} + + p-limit@2.3.0: + resolution: {integrity: sha512-//88mFWSJx8lxCzwdAABTJL2MyWB12+eIY7MDL2SqLmAkeKU9qxRvWuSyTjm3FUmpBEMuFfckAIqEaVGUDxb6w==} + engines: {node: '>=6'} + + p-limit@3.1.0: + resolution: {integrity: sha512-TYOanM3wGwNGsZN2cVTYPArw454xnXj5qmWF1bEoAc4+cU/ol7GVh7odevjp1FNHduHc3KZMcFduxU5Xc6uJRQ==} + engines: {node: '>=10'} + + p-locate@2.0.0: + resolution: {integrity: sha512-nQja7m7gSKuewoVRen45CtVfODR3crN3goVQ0DDZ9N3yHxgpkuBhZqsaiotSQRrADUrne346peY7kT3TSACykg==} + engines: {node: '>=4'} + + p-locate@4.1.0: + resolution: {integrity: sha512-R79ZZ/0wAxKGu3oYMlz8jy/kbhsNrS7SKZ7PxEHBgJ5+F2mtFW2fK2cOtBh1cHYkQsbzFV7I+EoRKe6Yt0oK7A==} + engines: {node: '>=8'} + + p-locate@5.0.0: + resolution: {integrity: sha512-LaNjtRWUBY++zB5nE/NwcaoMylSPk+S+ZHNB1TzdbMJMny6dynpAGt7X/tl/QYq3TIeE6nxHppbo2LGymrG5Pw==} + engines: {node: '>=10'} + + p-map@4.0.0: + resolution: {integrity: sha512-/bjOqmgETBYB5BoEeGVea8dmvHb2m9GLy1E9W43yeyfP6QQCZGFNa+XRceJEuDB6zqr+gKpIAmlLebMpykw/MQ==} + engines: {node: '>=10'} + + p-try@1.0.0: + resolution: {integrity: sha512-U1etNYuMJoIz3ZXSrrySFjsXQTWOx2/jdi86L+2pRvph/qMKL6sbcCYdH23fqsbm8TH2Gn0OybpT4eSFlCVHww==} + engines: {node: '>=4'} + + p-try@2.2.0: + resolution: {integrity: sha512-R4nPAVTAU0B9D35/Gk3uJf/7XYbQcyohSKdvAxIRSNghFl4e71hVoGnBNQz9cWaXxO2I10KTC+3jMdvvoKw6dQ==} + engines: {node: '>=6'} + + package-json-from-dist@1.0.0: + resolution: {integrity: sha512-dATvCeZN/8wQsGywez1mzHtTlP22H8OEfPrVMLNr4/eGa+ijtLn/6M5f0dY8UKNrC2O9UCU6SSoG3qRKnt7STw==} + + parent-module@1.0.1: + resolution: {integrity: sha512-GQ2EWRpQV8/o+Aw8YqtfZZPfNRWZYkbidE9k5rpl/hC3vtHHBfGm2Ifi6qWV+coDGkrUKZAxE3Lot5kcsRlh+g==} + engines: {node: '>=6'} + + parse-cache-control@1.0.1: + resolution: {integrity: sha512-60zvsJReQPX5/QP0Kzfd/VrpjScIQ7SHBW6bFCYfEP+fp0Eppr1SHhIO5nd1PjZtvclzSzES9D/p5nFJurwfWg==} + + parse-json@4.0.0: + resolution: {integrity: sha512-aOIos8bujGN93/8Ox/jPLh7RwVnPEysynVFE+fQZyg6jKELEHwzgKdLRFHUgXJL6kylijVSBC4BvN9OmsB48Rw==} + engines: {node: '>=4'} + + parse-json@5.2.0: + resolution: {integrity: sha512-ayCKvm/phCGxOkYRSCM82iDwct8/EonSEgCSxWxD7ve6jHggsFl4fZVQBPRNgQoKiuV/odhFrGzQXZwbifC8Rg==} + engines: {node: '>=8'} + + parse-passwd@1.0.0: + resolution: {integrity: sha512-1Y1A//QUXEZK7YKz+rD9WydcE1+EuPr6ZBgKecAB8tmoW6UFv0NREVJe1p+jRxtThkcbbKkfwIbWJe/IeE6m2Q==} + engines: {node: '>=0.10.0'} + + path-exists@3.0.0: + resolution: {integrity: sha512-bpC7GYwiDYQ4wYLe+FA8lhRjhQCMcQGuSgGGqDkg/QerRWw9CmGRT0iSOVRSZJ29NMLZgIzqaljJ63oaL4NIJQ==} + engines: {node: '>=4'} + + path-exists@4.0.0: + resolution: {integrity: sha512-ak9Qy5Q7jYb2Wwcey5Fpvg2KoAc/ZIhLSLOSBmRmygPsGwkVVt0fZa0qrtMz+m6tJTAHfZQ8FnmB4MG4LWy7/w==} + engines: {node: '>=8'} + + path-is-absolute@1.0.1: + resolution: {integrity: sha512-AVbw3UJ2e9bq64vSaS9Am0fje1Pa8pbGqTTsmXfaIiMpnr5DlDhfJOuLj9Sf95ZPVDAUerDfEk88MPmPe7UCQg==} + engines: {node: '>=0.10.0'} + + path-key@3.1.1: + resolution: {integrity: sha512-ojmeN0qd+y0jszEtoY48r0Peq5dwMEkIlCOu6Q5f41lfkswXuKtYrhgoTpLnyIcHm24Uhqx+5Tqm2InSwLhE6Q==} + engines: {node: '>=8'} + + path-key@4.0.0: + resolution: {integrity: sha512-haREypq7xkM7ErfgIyA0z+Bj4AGKlMSdlQE2jvJo6huWD1EdkKYV+G/T4nq0YEF2vgTT8kqMFKo1uHn950r4SQ==} + engines: {node: '>=12'} + + path-parse@1.0.7: + resolution: {integrity: sha512-LDJzPVEEEPR+y48z93A0Ed0yXb8pAByGWo/k5YYdYgpY2/2EsOsksJrq7lOHxryrVOn1ejG6oAp8ahvOIQD8sw==} + + path-scurry@1.11.1: + resolution: {integrity: sha512-Xa4Nw17FS9ApQFJ9umLiJS4orGjm7ZzwUrwamcGQuHSzDyth9boKDaycYdDcZDuqYATXw4HFXgaqWTctW/v1HA==} + engines: {node: '>=16 || 14 >=14.18'} + + path-starts-with@2.0.1: + resolution: {integrity: sha512-wZ3AeiRBRlNwkdUxvBANh0+esnt38DLffHDujZyRHkqkaKHTglnY2EP5UX3b8rdeiSutgO4y9NEJwXezNP5vHg==} + engines: {node: '>=8'} + + path-type@3.0.0: + resolution: {integrity: sha512-T2ZUsdZFHgA3u4e5PfPbjd7HDDpxPnQb5jN0SrDsjNSuVXHJqtwTnWqG0B1jZrgmJ/7lj1EmVIByWt1gxGkWvg==} + engines: {node: '>=4'} + + path-type@4.0.0: + resolution: {integrity: sha512-gDKb8aZMDeD/tZWs9P6+q0J9Mwkdl6xMV8TjnGP3qJVJ06bdMgkbBlLU8IdfOsIsFz2BW1rNVT3XuNEl8zPAvw==} + engines: {node: '>=8'} + + pathval@1.1.1: + resolution: {integrity: sha512-Dp6zGqpTdETdR63lehJYPeIOqpiNBNtc7BpWSLrOje7UaIsE5aY92r/AunQA7rsXvet3lrJ3JnZX29UPTKXyKQ==} + + pbkdf2@3.1.2: + resolution: {integrity: sha512-iuh7L6jA7JEGu2WxDwtQP1ddOpaJNC4KlDEFfdQajSGgGPNi4OyDc2R7QnbY2bR9QjBVGwgvTdNJZoE7RaxUMA==} + engines: {node: '>=0.12'} + + picocolors@1.1.0: + resolution: {integrity: sha512-TQ92mBOW0l3LeMeyLV6mzy/kWr8lkd/hp3mTg7wYK7zJhuBStmGMBG0BdeDZS/dZx1IukaX6Bk11zcln25o1Aw==} + + picomatch@2.3.1: + resolution: {integrity: sha512-JU3teHTNjmE2VCGFzuY8EXzCDVwEqB2a8fsIvwaStHhAWJEeVd1o1QD80CU6+ZdEXXSLbSsuLwJjkCBWqRQUVA==} + engines: {node: '>=8.6'} + + pidtree@0.6.0: + resolution: {integrity: sha512-eG2dWTVw5bzqGRztnHExczNxt5VGsE6OwTeCG3fdUf9KBsZzO3R5OIIIzWR+iZA0NtZ+RDVdaoE2dK1cn6jH4g==} + engines: {node: '>=0.10'} + hasBin: true + + pify@3.0.0: + resolution: {integrity: sha512-C3FsVNH1udSEX48gGX1xfvwTWfsYWj5U+8/uK15BGzIGrKoUpghX8hWZwa/OFnakBiiVNmBvemTJR5mcy7iPcg==} + engines: {node: '>=4'} + + pify@4.0.1: + resolution: {integrity: sha512-uB80kBFb/tfd68bVleG9T5GGsGPjJrLAUpR5PZIrhBnIaRTQRjqdJSsIKkOP6OAIFbj7GOrcudc5pNjZ+geV2g==} + engines: {node: '>=6'} + + pluralize@8.0.0: + resolution: {integrity: sha512-Nc3IT5yHzflTfbjgqWcCPpo7DaKy4FnpB0l/zCAW0Tc7jxAiuqSxHasntB3D7887LSrA93kDJ9IXovxJYxyLCA==} + engines: {node: '>=4'} + + postcss@8.4.45: + resolution: {integrity: sha512-7KTLTdzdZZYscUc65XmjFiB73vBhBfbPztCYdUNvlaso9PrzjzcmjqBPR0lNGkcVlcO4BjiO5rK/qNz+XAen1Q==} + engines: {node: ^10 || ^12 || >=14} + + prelude-ls@1.1.2: + resolution: {integrity: sha512-ESF23V4SKG6lVSGZgYNpbsiaAkdab6ZgOxe52p7+Kid3W3u3bxR4Vfd/o21dmN7jSt0IwgZ4v5MUd26FEtXE9w==} + engines: {node: '>= 0.8.0'} + + prelude-ls@1.2.1: + resolution: {integrity: sha512-vkcDPrRZo1QZLbn5RLGPpg/WmIQ65qoWWhcGKf/b5eplkkarX0m9z8ppCat4mlOqUsWpyNuYgO3VRyrYHSzX5g==} + engines: {node: '>= 0.8.0'} + + prettier-linter-helpers@1.0.0: + resolution: {integrity: sha512-GbK2cP9nraSSUF9N2XwUwqfzlAFlMNYYl+ShE/V+H8a9uNl/oUqB1w2EL54Jh0OlyRSd8RfWYJ3coVS4TROP2w==} + engines: {node: '>=6.0.0'} + + prettier-plugin-solidity@1.4.1: + resolution: {integrity: sha512-Mq8EtfacVZ/0+uDKTtHZGW3Aa7vEbX/BNx63hmVg6YTiTXSiuKP0amj0G6pGwjmLaOfymWh3QgXEZkjQbU8QRg==} + engines: {node: '>=16'} + peerDependencies: + prettier: '>=2.3.0' + + prettier@2.8.8: + resolution: {integrity: sha512-tdN8qQGvNjw4CHbY+XXk0JgCXn9QiF21a55rBe5LJAU+kDyC4WQn4+awm2Xfk2lQMk5fKup9XgzTZtGkjBdP9Q==} + engines: {node: '>=10.13.0'} + hasBin: true + + process-nextick-args@2.0.1: + resolution: {integrity: sha512-3ouUOpQhtgrbOa17J7+uxOTpITYWaGP7/AhoR3+A+/1e9skrzelGi/dXzEYyvbxubEF6Wn2ypscTKiKJFFn1ag==} + + promise@8.3.0: + resolution: {integrity: sha512-rZPNPKTOYVNEEKFaq1HqTgOwZD+4/YHS5ukLzQCypkj+OkYx7iv0mA91lJlpPPZ8vMau3IIGj5Qlwrx+8iiSmg==} + + prompts@2.4.2: + resolution: {integrity: sha512-NxNv/kLguCA7p3jE8oL2aEBsrJWgAakBpgmgK6lpPWV+WuOmY6r2/zbAVnP+T8bQlA0nzHXSJSJW0Hq7ylaD2Q==} + engines: {node: '>= 6'} + + proper-lockfile@4.1.2: + resolution: {integrity: sha512-TjNPblN4BwAWMXU8s9AEz4JmQxnD1NNL7bNOY/AKUzyamc379FWASUhc/K1pL2noVb+XmZKLL68cjzLsiOAMaA==} + + proxy-from-env@1.1.0: + resolution: {integrity: sha512-D+zkORCbA9f1tdWRK0RaCR3GPv50cMxcrz4X8k5LTSUD1Dkw47mKJEZQNunItRTkWwgtaUSo1RVFRIG9ZXiFYg==} + + punycode@2.3.1: + resolution: {integrity: sha512-vYt7UD1U9Wg6138shLtLOvdAu+8DsC/ilFtEVHcH+wydcSpNE20AfSOduf6MkRFahL5FY7X1oU7nKVZFtfq8Fg==} + engines: {node: '>=6'} + + qs@6.13.0: + resolution: {integrity: sha512-+38qI9SOr8tfZ4QmJNplMUxqjbe7LKvvZgWdExBOmd+egZTtjLB67Gu0HRX3u/XOq7UU2Nx6nsjvS16Z9uwfpg==} + engines: {node: '>=0.6'} + + queue-microtask@1.2.3: + resolution: {integrity: sha512-NuaNSa6flKT5JaSYQzJok04JzTL1CA6aGhv5rfLW3PgqA+M2ChpZQnAC8h8i4ZFkBS8X5RqkDBHA7r4hej3K9A==} + + quick-lru@4.0.1: + resolution: {integrity: sha512-ARhCpm70fzdcvNQfPoy49IaanKkTlRWF2JMzqhcJbhSFRZv7nPTvZJdcY7301IPmvW+/p0RgIWnQDLJxifsQ7g==} + engines: {node: '>=8'} + + randombytes@2.1.0: + resolution: {integrity: sha512-vYl3iOX+4CKUWuxGi9Ukhie6fsqXqS9FE2Zaic4tNFD2N2QQaXOMFbuKK4QmDHC0JO6B1Zp41J0LpT0oR68amQ==} + + raw-body@2.5.2: + resolution: {integrity: sha512-8zGqypfENjCIqGhgXToC8aB2r7YrBX+AQAfIPs/Mlk+BtPTztOvTS01NRW/3Eh60J+a48lt8qsCzirQ6loCVfA==} + engines: {node: '>= 0.8'} + + read-pkg-up@7.0.1: + resolution: {integrity: sha512-zK0TB7Xd6JpCLmlLmufqykGE+/TlOePD6qKClNW7hHDKFh/J7/7gCWGR7joEQEW1bKq3a3yUZSObOoWLFQ4ohg==} + engines: {node: '>=8'} + + read-pkg@3.0.0: + resolution: {integrity: sha512-BLq/cCO9two+lBgiTYNqD6GdtK8s4NpaWrl6/rCO9w0TUS8oJl7cmToOZfRYllKTISY6nt1U7jQ53brmKqY6BA==} + engines: {node: '>=4'} + + read-pkg@5.2.0: + resolution: {integrity: sha512-Ug69mNOpfvKDAc2Q8DRpMjjzdtrnv9HcSMX+4VsZxD1aZ6ZzrIE7rlzXBtWTyhULSMKg076AW6WR5iZpD0JiOg==} + engines: {node: '>=8'} + + readable-stream@2.3.8: + resolution: {integrity: sha512-8p0AUk4XODgIewSi0l8Epjs+EVnWiK7NoDIEGU0HhE7+ZyY8D1IMY7odu5lRrFXGg71L15KG8QrPmum45RTtdA==} + + readable-stream@3.6.2: + resolution: {integrity: sha512-9u/sniCrY3D5WdsERHzHE4G2YCXqoG5FTHUiCC4SIbr6XcLZBY05ya9EKjYek9O5xOAwjGq+1JdGBAS7Q9ScoA==} + engines: {node: '>= 6'} + + readdirp@3.6.0: + resolution: {integrity: sha512-hOS089on8RduqdbhvQ5Z37A0ESjsqz6qnRcffsMU3495FuTdqSm+7bhJ29JvIOsBDEEnan5DPu9t3To9VRlMzA==} + engines: {node: '>=8.10.0'} + + rechoir@0.6.2: + resolution: {integrity: sha512-HFM8rkZ+i3zrV+4LQjwQ0W+ez98pApMGM3HUrN04j3CqzPOzl9nmP15Y8YXNm8QHGv/eacOVEjqhmWpkRV0NAw==} + engines: {node: '>= 0.10'} + + recursive-readdir@2.2.3: + resolution: {integrity: sha512-8HrF5ZsXk5FAH9dgsx3BlUer73nIhuj+9OrQwEbLTPOBzGkL1lsFCR01am+v+0m2Cmbs1nP12hLDl5FA7EszKA==} + engines: {node: '>=6.0.0'} + + redent@3.0.0: + resolution: {integrity: sha512-6tDA8g98We0zd0GvVeMT9arEOnTw9qM03L9cJXaCjrip1OO764RDBLBfrB4cwzNGDj5OA5ioymC9GkizgWJDUg==} + engines: {node: '>=8'} + + reduce-flatten@2.0.0: + resolution: {integrity: sha512-EJ4UNY/U1t2P/2k6oqotuX2Cc3T6nxJwsM0N0asT7dhrtH1ltUxDn4NalSYmPE2rCkVpcf/X6R0wDwcFpzhd4w==} + engines: {node: '>=6'} + + req-cwd@2.0.0: + resolution: {integrity: sha512-ueoIoLo1OfB6b05COxAA9UpeoscNpYyM+BqYlA7H6LVF4hKGPXQQSSaD2YmvDVJMkk4UDpAHIeU1zG53IqjvlQ==} + engines: {node: '>=4'} + + req-from@2.0.0: + resolution: {integrity: sha512-LzTfEVDVQHBRfjOUMgNBA+V6DWsSnoeKzf42J7l0xa/B4jyPOuuF5MlNSmomLNGemWTnV2TIdjSSLnEn95fOQA==} + engines: {node: '>=4'} + + require-directory@2.1.1: + resolution: {integrity: sha512-fGxEI7+wsG9xrvdjsrlmL22OMTTiHRwAMroiEeMgq8gzoLC/PQr7RsRDSTLUg/bZAZtF+TVIkHc6/4RIKrui+Q==} + engines: {node: '>=0.10.0'} + + require-from-string@2.0.2: + resolution: {integrity: sha512-Xf0nWe6RseziFMu+Ap9biiUbmplq6S9/p+7w7YXP/JBHhrUDDUhwa+vANyubuqfZWTveU//DYVGsDG7RKL/vEw==} + engines: {node: '>=0.10.0'} + + resolve-dir@1.0.1: + resolution: {integrity: sha512-R7uiTjECzvOsWSfdM0QKFNBVFcK27aHOUwdvK53BcW8zqnGdYp0Fbj82cy54+2A4P2tFM22J5kRfe1R+lM/1yg==} + engines: {node: '>=0.10.0'} + + resolve-from@3.0.0: + resolution: {integrity: sha512-GnlH6vxLymXJNMBo7XP1fJIzBFbdYt49CuTwmB/6N53t+kMPRMFKz783LlQ4tv28XoQfMWinAJX6WCGf2IlaIw==} + engines: {node: '>=4'} + + resolve-from@4.0.0: + resolution: {integrity: sha512-pb/MYmXstAkysRFx8piNI1tGFNQIFA3vkE3Gq4EuA1dF6gHp/+vgZqsCGJapvy8N3Q+4o7FwvquPJcnZ7RYy4g==} + engines: {node: '>=4'} + + resolve-from@5.0.0: + resolution: {integrity: sha512-qYg9KP24dD5qka9J47d0aVky0N+b4fTU89LN9iDnjB5waksiC49rvMB0PrUJQGoTmH50XPiqOvAjDfaijGxYZw==} + engines: {node: '>=8'} + + resolve-global@1.0.0: + resolution: {integrity: sha512-zFa12V4OLtT5XUX/Q4VLvTfBf+Ok0SPc1FNGM/z9ctUdiU618qwKpWnd0CHs3+RqROfyEg/DhuHbMWYqcgljEw==} + engines: {node: '>=8'} + + resolve-pkg-maps@1.0.0: + resolution: {integrity: sha512-seS2Tj26TBVOC2NIc2rOe2y2ZO7efxITtLZcGSOnHHNOQ7CkiUBfw0Iw2ck6xkIhPwLhKNLS8BO+hEpngQlqzw==} + + resolve@1.1.7: + resolution: {integrity: sha512-9znBF0vBcaSN3W2j7wKvdERPwqTxSpCq+if5C0WoTCyV9n24rua28jeuQ2pL/HOf+yUe/Mef+H/5p60K0Id3bg==} + + resolve@1.17.0: + resolution: {integrity: sha512-ic+7JYiV8Vi2yzQGFWOkiZD5Z9z7O2Zhm9XMaTxdJExKasieFCr+yXZ/WmXsckHiKl12ar0y6XiXDx3m4RHn1w==} + + resolve@1.22.8: + resolution: {integrity: sha512-oKWePCxqpd6FlLvGV1VU0x7bkPmmCNolxzjMf4NczoDnQcIWrAF+cPtZn5i6n+RfD2d9i0tzpKnG6Yk168yIyw==} + hasBin: true + + restore-cursor@3.1.0: + resolution: {integrity: sha512-l+sSefzHpj5qimhFSE5a8nufZYAM3sBSVMAPtYkmC+4EH2anSGaEMXSD0izRQbu9nfyQ9y5JrVmp7E8oZrUjvA==} + engines: {node: '>=8'} + + restore-cursor@4.0.0: + resolution: {integrity: sha512-I9fPXU9geO9bHOt9pHHOhOkYerIMsmVaWB0rA2AI9ERh/+x/i7MV5HKBNrg+ljO5eoPVgCcnFuRjJ9uH6I/3eg==} + engines: {node: ^12.20.0 || ^14.13.1 || >=16.0.0} + + retry@0.12.0: + resolution: {integrity: sha512-9LkiTwjUh6rT555DtE9rTX+BKByPfrMzEAtnlEtdEwr3Nkffwiihqe2bWADg+OQRjt9gl6ICdmB/ZFDCGAtSow==} + engines: {node: '>= 4'} + + retry@0.13.1: + resolution: {integrity: sha512-XQBQ3I8W1Cge0Seh+6gjj03LbmRFWuoszgK9ooCpwYIrhhoO80pfq4cUkU5DkknwfOfFteRwlZ56PYOGYyFWdg==} + engines: {node: '>= 4'} + + reusify@1.0.4: + resolution: {integrity: sha512-U9nH88a3fc/ekCF1l0/UP1IosiuIjyTh7hBvXVMHYgVcfGvt897Xguj2UOLDeI5BG2m7/uwyaLVT6fbtCwTyzw==} + engines: {iojs: '>=1.0.0', node: '>=0.10.0'} + + rfdc@1.4.1: + resolution: {integrity: sha512-q1b3N5QkRUWUl7iyylaaj3kOpIT0N2i9MqIEQXP73GVsN9cw3fdx8X63cEmWhJGi2PPCF23Ijp7ktmd39rawIA==} + + rimraf@2.7.1: + resolution: {integrity: sha512-uWjbaKIK3T1OSVptzX7Nl6PvQ3qAGtKEtVRjRuazjfL3Bx5eI409VZSqgND+4UNnmzLVdPj9FqFJNPqBZFve4w==} + deprecated: Rimraf versions prior to v4 are no longer supported + hasBin: true + + rimraf@3.0.2: + resolution: {integrity: sha512-JZkJMZkAGFFPP2YqXZXPbMlMBgsxzE8ILs4lMIX/2o0L9UBw9O/Y3o6wFw/i9YLapcUJWwqbi3kdxIPdC62TIA==} + deprecated: Rimraf versions prior to v4 are no longer supported + hasBin: true + + rimraf@5.0.10: + resolution: {integrity: sha512-l0OE8wL34P4nJH/H2ffoaniAokM2qSmrtXHmlpvYr5AVVX8msAyW0l8NVJFDxlSK4u3Uh/f41cQheDVdnYijwQ==} + hasBin: true + + ripemd160@2.0.2: + resolution: {integrity: sha512-ii4iagi25WusVoiC4B4lq7pbXfAp3D9v5CwfkY33vffw2+pkDjY1D8GaN7spsxvCSx8dkPqOZCEZyfxcmJG2IA==} + + rlp@2.2.7: + resolution: {integrity: sha512-d5gdPmgQ0Z+AklL2NVXr/IoSjNZFfTVvQWzL/AM2AOcSzYP2xjlb0AC8YyCLc41MSNf6P6QVtjgPdmVtzb+4lQ==} + hasBin: true + + rollup-plugin-auto-external@2.0.0: + resolution: {integrity: sha512-HQM3ZkZYfSam1uoZtAB9sK26EiAsfs1phrkf91c/YX+S07wugyRXSigBxrIwiLr5EPPilKYmoMxsrnlGBsXnuQ==} + engines: {node: '>=6'} + peerDependencies: + rollup: '>=0.45.2' + + rollup-plugin-dts@6.1.1: + resolution: {integrity: sha512-aSHRcJ6KG2IHIioYlvAOcEq6U99sVtqDDKVhnwt70rW6tsz3tv5OSjEiWcgzfsHdLyGXZ/3b/7b/+Za3Y6r1XA==} + engines: {node: '>=16'} + peerDependencies: + rollup: ^3.29.4 || ^4 + typescript: ^4.5 || ^5.0 + + rollup-plugin-esbuild@6.1.1: + resolution: {integrity: sha512-CehMY9FAqJD5OUaE/Mi1r5z0kNeYxItmRO2zG4Qnv2qWKF09J2lTy5GUzjJR354ZPrLkCj4fiBN41lo8PzBUhw==} + engines: {node: '>=14.18.0'} + peerDependencies: + esbuild: '>=0.18.0' + rollup: ^1.20.0 || ^2.0.0 || ^3.0.0 || ^4.0.0 + + rollup-plugin-inject@3.0.2: + resolution: {integrity: sha512-ptg9PQwzs3orn4jkgXJ74bfs5vYz1NCZlSQMBUA0wKcGp5i5pA1AO3fOUEte8enhGUC+iapTCzEWw2jEFFUO/w==} + deprecated: This package has been deprecated and is no longer maintained. Please use @rollup/plugin-inject. + + rollup-plugin-node-polyfills@0.2.1: + resolution: {integrity: sha512-4kCrKPTJ6sK4/gLL/U5QzVT8cxJcofO0OU74tnB19F40cmuAKSzH5/siithxlofFEjwvw1YAhPmbvGNA6jEroA==} + + rollup-plugin-swc3@0.11.2: + resolution: {integrity: sha512-o1ih9B806fV2wBSNk46T0cYfTF2eiiKmYXRpWw3K4j/Cp3tCAt10UCVsTqvUhGP58pcB3/GZcAVl5e7TCSKN6Q==} + engines: {node: '>=12'} + peerDependencies: + '@swc/core': '>=1.2.165' + rollup: ^2.0.0 || ^3.0.0 || ^4.0.0 + + rollup-pluginutils@2.8.2: + resolution: {integrity: sha512-EEp9NhnUkwY8aif6bxgovPHMoMoNr2FulJziTndpt5H9RdwC47GSGuII9XxpSdzVGM0GWrNPHV6ie1LTNJPaLQ==} + + rollup-preserve-directives@1.1.1: + resolution: {integrity: sha512-+eQafbuEfDPfxQ9hQPlwaROfin4yiVRxap8hnrvvvcSGoukv1tTiYpAW9mvm3uR8J+fe4xd8FdVd5rz9q7jZ+Q==} + peerDependencies: + rollup: ^2.0.0 || ^3.0.0 || ^4.0.0 + + rollup@4.21.2: + resolution: {integrity: sha512-e3TapAgYf9xjdLvKQCkQTnbTKd4a6jwlpQSJJFokHGaX2IVjoEqkIIhiQfqsi0cdwlOD+tQGuOd5AJkc5RngBw==} + engines: {node: '>=18.0.0', npm: '>=8.0.0'} + hasBin: true + + run-async@2.4.1: + resolution: {integrity: sha512-tvVnVv01b8c1RrA6Ep7JkStj85Guv/YrMcwqYQnwjsAS2cTmmPGBBjAjpCW7RrSodNSoE2/qg9O4bceNvUuDgQ==} + engines: {node: '>=0.12.0'} + + run-parallel@1.2.0: + resolution: {integrity: sha512-5l4VyZR86LZ/lDxZTR6jqL8AFE2S0IFLMP26AbjsLVADxHdhB/c0GUsH+y39UfCi3dzz8OlQuPmnaJOMoDHQBA==} + + rxjs@7.8.1: + resolution: {integrity: sha512-AA3TVj+0A2iuIoQkWEK/tqFjBq2j+6PO6Y0zJcvzLAFhEFIO3HL0vls9hWLncZbAAbK0mar7oZ4V079I/qPMxg==} + + safe-buffer@5.1.2: + resolution: {integrity: sha512-Gd2UZBJDkXlY7GbJxfsE8/nvKkUEU1G38c1siN6QP6a9PT9MmHB8GnpscSmMJSoF8LOIrt8ud/wPtojys4G6+g==} + + safe-buffer@5.2.1: + resolution: {integrity: sha512-rp3So07KcdmmKbGvgaNxQSJr7bGVSVk5S9Eq1F+ppbRo70+YeaDxkw5Dd8NPN+GD6bjnYm2VuPuCXmpuYvmCXQ==} + + safe-resolve@1.0.0: + resolution: {integrity: sha512-aQpRvfxoi1y0UxKEU0tNO327kb0/LMo8Xrk64M2u172UqOOLCCM0khxN2OTClDiTqTJz5864GMD1X92j4YiHTg==} + + safer-buffer@2.1.2: + resolution: {integrity: sha512-YZo3K82SD7Riyi0E1EQPojLz7kpepnSQI9IyPbHHg1XXXevb5dJI7tpyN2ADxGcQbHG7vcyRHk0cbwqcQriUtg==} + + sc-istanbul@0.4.6: + resolution: {integrity: sha512-qJFF/8tW/zJsbyfh/iT/ZM5QNHE3CXxtLJbZsL+CzdJLBsPD7SedJZoUA4d8iAcN2IoMp/Dx80shOOd2x96X/g==} + hasBin: true + + scrypt-js@3.0.1: + resolution: {integrity: sha512-cdwTTnqPu0Hyvf5in5asVdZocVDTNRmR7XEcJuIzMjJeSHybHl7vpB66AzwTaIg6CLSbtjcxc8fqcySfnTkccA==} + + secp256k1@4.0.3: + resolution: {integrity: sha512-NLZVf+ROMxwtEj3Xa562qgv2BK5e2WNmXPiOdVIPLgs6lyTzMvBq0aWTYMI5XCP9jZMVKOcqZLw/Wc4vDkuxhA==} + engines: {node: '>=10.0.0'} + + semver@5.7.2: + resolution: {integrity: sha512-cBznnQ9KjJqU67B52RMC65CMarK2600WFnbkcaiwWq3xy/5haFJlshgnpjovMVJ+Hff49d8GEn0b87C5pDQ10g==} + hasBin: true + + semver@6.3.1: + resolution: {integrity: sha512-BR7VvDCVHO+q2xBEWskxS6DJE1qRnb7DxzUrogb71CWoSficBxYsiAGd+Kl0mmq/MprG9yArRkyrQxTO6XjMzA==} + hasBin: true + + semver@7.5.4: + resolution: {integrity: sha512-1bCSESV6Pv+i21Hvpxp3Dx+pSD8lIPt8uVjRrxAUt/nbswYc+tK6Y2btiULjd4+fnq15PX+nqQDC7Oft7WkwcA==} + engines: {node: '>=10'} + hasBin: true + + semver@7.6.3: + resolution: {integrity: sha512-oVekP1cKtI+CTDvHWYFUcMtsK/00wmAEfyqKfNdARm8u1wNVhSgaX7A8d4UuIlUI5e84iEwOhs7ZPYRmzU9U6A==} + engines: {node: '>=10'} + hasBin: true + + serialize-javascript@6.0.2: + resolution: {integrity: sha512-Saa1xPByTTq2gdeFZYLLo+RFE35NHZkAbqZeWNd3BpzppeVisAqpDjcp8dyf6uIvEqJRd46jemmyA4iFIeVk8g==} + + set-function-length@1.2.2: + resolution: {integrity: sha512-pgRc4hJ4/sNjWCSS9AmnS40x3bNMDTknHgL5UaMBTMyJnU90EgWh1Rz+MC9eFu4BuN/UwZjKQuY/1v3rM7HMfg==} + engines: {node: '>= 0.4'} + + setimmediate@1.0.5: + resolution: {integrity: sha512-MATJdZp8sLqDl/68LfQmbP8zKPLQNV6BIZoIgrscFDQ+RsvK/BxeDQOgyxKKoh0y/8h3BqVFnCqQ/gd+reiIXA==} + + setprototypeof@1.2.0: + resolution: {integrity: sha512-E5LDX7Wrp85Kil5bhZv46j8jOeboKq5JMmYM3gVGdGH8xFpPWXUMsNrlODCrkoxMEeNi/XZIwuRvY4XNwYMJpw==} + + sha.js@2.4.11: + resolution: {integrity: sha512-QMEp5B7cftE7APOjk5Y6xgrbWu+WkLVQwk8JNjZ8nKRciZaByEW6MubieAiToS7+dwvrjGhH8jRXz3MVd0AYqQ==} + hasBin: true + + sha1@1.1.1: + resolution: {integrity: sha512-dZBS6OrMjtgVkopB1Gmo4RQCDKiZsqcpAQpkV/aaj+FCrCg8r4I4qMkDPQjBgLIxlmu9k4nUbWq6ohXahOneYA==} + + shebang-command@2.0.0: + resolution: {integrity: sha512-kHxr2zZpYtdmrN1qDjrrX/Z1rR1kG8Dx+gkpK1G4eXmvXswmcE1hTWBWYUzlraYw1/yZp6YuDY77YtvbN0dmDA==} + engines: {node: '>=8'} + + shebang-regex@3.0.0: + resolution: {integrity: sha512-7++dFhtcx3353uBaq8DDR4NuxBetBzC7ZQOhmTQInHEd6bSrXdiEyzCvG07Z44UYdLShWUyXt5M/yhz8ekcb1A==} + engines: {node: '>=8'} + + shelljs@0.8.5: + resolution: {integrity: sha512-TiwcRcrkhHvbrZbnRcFYMLl30Dfov3HKqzp5tO5b4pt6G/SezKcYhmDg15zXVBswHmctSAQKznqNW2LO5tTDow==} + engines: {node: '>=4'} + hasBin: true + + shx@0.3.4: + resolution: {integrity: sha512-N6A9MLVqjxZYcVn8hLmtneQWIJtp8IKzMP4eMnx+nqkvXoqinUPCbUFLp2UcWTEIUONhlk0ewxr/jaVGlc+J+g==} + engines: {node: '>=6'} + hasBin: true + + side-channel@1.0.6: + resolution: {integrity: sha512-fDW/EZ6Q9RiO8eFG8Hj+7u/oW+XrPTIChwCOM2+th2A6OblDtYYIpve9m+KvI9Z4C9qSEXlaGR6bTEYHReuglA==} + engines: {node: '>= 0.4'} + + signal-exit@3.0.7: + resolution: {integrity: sha512-wnD2ZE+l+SPC/uoS0vXeE9L1+0wuaMqKlfz9AMUo38JsyLSBWSFcHR1Rri62LZc12vLr1gb3jl7iwQhgwpAbGQ==} + + signal-exit@4.1.0: + resolution: {integrity: sha512-bzyZ1e88w9O1iNJbKnOlvYTrWPDl46O1bG0D3XInv+9tkPrxrN8jUUTiFlDkkmKWgn1M6CfIA13SuGqOa9Korw==} + engines: {node: '>=14'} + + sisteransi@1.0.5: + resolution: {integrity: sha512-bLGGlR1QxBcynn2d5YmDX4MGjlZvy2MRBDRNHLJ8VI6l6+9FUiyTFNJ0IveOSP0bcXgVDPRcfGqA0pjaqUpfVg==} + + slash@3.0.0: + resolution: {integrity: sha512-g9Q1haeby36OSStwb4ntCGGGaKsaVSjQ68fBxoQcutl5fS1vuY18H3wSt3jFyFtrkx+Kz0V1G85A4MyAdDMi2Q==} + engines: {node: '>=8'} + + slice-ansi@4.0.0: + resolution: {integrity: sha512-qMCMfhY040cVHT43K9BFygqYbUPFZKHOg7K73mtTWJRb8pyP3fzf4Ixd5SzdEJQ6MRUg/WBnOLxghZtKKurENQ==} + engines: {node: '>=10'} + + slice-ansi@5.0.0: + resolution: {integrity: sha512-FC+lgizVPfie0kkhqUScwRu1O/lF6NOgJmlCgK+/LYxDCTk8sGelYaHDhFcDN+Sn3Cv+3VSa4Byeo+IMCzpMgQ==} + engines: {node: '>=12'} + + solc@0.8.26: + resolution: {integrity: sha512-yiPQNVf5rBFHwN6SIf3TUUvVAFKcQqmSUFeq+fb6pNRCo0ZCgpYOZDi3BVoezCPIAcKrVYd/qXlBLUP9wVrZ9g==} + engines: {node: '>=10.0.0'} + hasBin: true + + solhint-plugin-prettier@0.0.5: + resolution: {integrity: sha512-7jmWcnVshIrO2FFinIvDQmhQpfpS2rRRn3RejiYgnjIE68xO2bvrYvjqVNfrio4xH9ghOqn83tKuTzLjEbmGIA==} + peerDependencies: + prettier: ^1.15.0 || ^2.0.0 + prettier-plugin-solidity: ^1.0.0-alpha.14 + + solhint@3.6.2: + resolution: {integrity: sha512-85EeLbmkcPwD+3JR7aEMKsVC9YrRSxd4qkXuMzrlf7+z2Eqdfm1wHWq1ffTuo5aDhoZxp2I9yF3QkxZOxOL7aQ==} + hasBin: true + + solidity-ast@0.4.59: + resolution: {integrity: sha512-I+CX0wrYUN9jDfYtcgWSe+OAowaXy8/1YQy7NS4ni5IBDmIYBq7ZzaP/7QqouLjzZapmQtvGLqCaYgoUWqBo5g==} + + solidity-coverage@0.8.13: + resolution: {integrity: sha512-RiBoI+kF94V3Rv0+iwOj3HQVSqNzA9qm/qDP1ZDXK5IX0Cvho1qiz8hAXTsAo6KOIUeP73jfscq0KlLqVxzGWA==} + hasBin: true + peerDependencies: + hardhat: ^2.11.0 + + solmate@6.2.0: + resolution: {integrity: sha512-AM38ioQ2P8zRsA42zenb9or6OybRjOLXIu3lhIT8rhddUuduCt76pUEuLxOIg9GByGojGz+EbpFdCB6B+QZVVA==} + + source-map-js@1.2.1: + resolution: {integrity: sha512-UXWMKhLOwVKb728IUtQPXxfYU+usdybtUrK/8uGE8CQMvrhOpwvzDBwj0QhSL7MQc7vIsISBG8VQ8+IDQxpfQA==} + engines: {node: '>=0.10.0'} + + source-map-support@0.5.21: + resolution: {integrity: sha512-uBHU3L3czsIyYXKX88fdrGovxdSCoTGDRZ6SYXtSRxLZUzHg5P/66Ht6uoUlHu9EZod+inXhKo3qQgwXUT/y1w==} + + source-map@0.2.0: + resolution: {integrity: sha512-CBdZ2oa/BHhS4xj5DlhjWNHcan57/5YuvfdLf17iVmIpd9KRm+DFLmC6nBNj+6Ua7Kt3TmOjDpQT1aTYOQtoUA==} + engines: {node: '>=0.8.0'} + + source-map@0.5.7: + resolution: {integrity: sha512-LbrmJOMUSdEVxIKvdcJzQC+nQhe8FUZQTXQy6+I75skNgn3OoQ0DZA8YnFa7gp8tqtL3KPf1kmo0R5DoApeSGQ==} + engines: {node: '>=0.10.0'} + + source-map@0.6.1: + resolution: {integrity: sha512-UjgapumWlbMhkBgzT7Ykc5YXUT46F0iKu8SGXq0bcwP5dz/h0Plj6enJqjz1Zbq2l5WaqYnrVbwWOWMyF3F47g==} + engines: {node: '>=0.10.0'} + + sourcemap-codec@1.4.8: + resolution: {integrity: sha512-9NykojV5Uih4lgo5So5dtw+f0JgJX30KCNI8gwhz2J9A15wD0Ml6tjHKwf6fTSa6fAdVBdZeNOs9eJ71qCk8vA==} + deprecated: Please use @jridgewell/sourcemap-codec instead + + spdx-correct@3.2.0: + resolution: {integrity: sha512-kN9dJbvnySHULIluDHy32WHRUu3Og7B9sbY7tsFLctQkIqnMh3hErYgdMjTYuqmcXX+lK5T1lnUt3G7zNswmZA==} + + spdx-exceptions@2.5.0: + resolution: {integrity: sha512-PiU42r+xO4UbUS1buo3LPJkjlO7430Xn5SVAhdpzzsPHsjbYVflnnFdATgabnLude+Cqu25p6N+g2lw/PFsa4w==} + + spdx-expression-parse@3.0.1: + resolution: {integrity: sha512-cbqHunsQWnJNE6KhVSMsMeH5H/L9EpymbzqTQ3uLwNCLZ1Q481oWaofqH7nO6V07xlXwY6PhQdQ2IedWx/ZK4Q==} + + spdx-license-ids@3.0.20: + resolution: {integrity: sha512-jg25NiDV/1fLtSgEgyvVyDunvaNHbuwF9lfNV17gSmPFAlYzdfNBlLtLzXTevwkPj7DhGbmN9VnmJIgLnhvaBw==} + + split2@3.2.2: + resolution: {integrity: sha512-9NThjpgZnifTkJpzTZ7Eue85S49QwpNhZTq6GRJwObb6jnLFNGB7Qm73V5HewTROPyxD0C29xqmaI68bQtV+hg==} + + sprintf-js@1.0.3: + resolution: {integrity: sha512-D9cPgkvLlV3t3IzL0D0YLvGA9Ahk4PcvVwUbN0dSGr1aP0Nrt4AEnTUbuGvquEC0mA64Gqt1fzirlRs5ibXx8g==} + + squirrelly@8.0.8: + resolution: {integrity: sha512-7dyZJ9Gw86MmH0dYLiESsjGOTj6KG8IWToTaqBuB6LwPI+hyNb6mbQaZwrfnAQ4cMDnSWMUvX/zAYDLTSWLk/w==} + engines: {node: '>=6.0.0'} + + stacktrace-parser@0.1.10: + resolution: {integrity: sha512-KJP1OCML99+8fhOHxwwzyWrlUuVX5GQ0ZpJTd1DFXhdkrvg1szxfHhawXUZ3g9TkXORQd4/WG68jMlQZ2p8wlg==} + engines: {node: '>=6'} + + statuses@2.0.1: + resolution: {integrity: sha512-RwNA9Z/7PrK06rYLIzFMlaF+l73iwpzsqRIFgbMLbTcLD6cOao82TaWefPXQvB2fOC4AjuYSEndS7N/mTCbkdQ==} + engines: {node: '>= 0.8'} + + string-argv@0.3.2: + resolution: {integrity: sha512-aqD2Q0144Z+/RqG52NeHEkZauTAUWJO8c6yTftGJKO3Tja5tUgIfmIl6kExvhtxSDP7fXB6DvzkfMpCd/F3G+Q==} + engines: {node: '>=0.6.19'} + + string-format@2.0.0: + resolution: {integrity: sha512-bbEs3scLeYNXLecRRuk6uJxdXUSj6le/8rNPHChIJTn2V79aXVTR1EH2OH5zLKKoz0V02fOUKZZcw01pLUShZA==} + + string-width@2.1.1: + resolution: {integrity: sha512-nOqH59deCq9SRHlxq1Aw85Jnt4w6KvLKqWVik6oA9ZklXLNIOlqg4F2yrT1MVaTjAqvVwdfeZ7w7aCvJD7ugkw==} + engines: {node: '>=4'} + + string-width@4.2.3: + resolution: {integrity: sha512-wKyQRQpjJ0sIp62ErSZdGsjMJWsap5oRNihHhu6G7JVO/9jIB6UyevL+tXuOqrng8j/cxKTWyWUwvSTriiZz/g==} + engines: {node: '>=8'} + + string-width@5.1.2: + resolution: {integrity: sha512-HnLOCR3vjcY8beoNLtcjZ5/nxn2afmME6lhrDrebokqMap+XbeW8n9TXpPDOqdGK5qcI3oT0GKTW6wC7EMiVqA==} + engines: {node: '>=12'} + + string_decoder@1.1.1: + resolution: {integrity: sha512-n/ShnvDi6FHbbVfviro+WojiFzv+s8MPMHBczVePfUpDJLwoLT0ht1l4YwBCbi8pJAveEEdnkHyPyTP/mzRfwg==} + + string_decoder@1.3.0: + resolution: {integrity: sha512-hkRX8U1WjJFd8LsDJ2yQ/wWWxaopEsABU1XfkM8A+j0+85JAGppt16cr1Whg6KIbb4okU6Mql6BOj+uup/wKeA==} + + strip-ansi@4.0.0: + resolution: {integrity: sha512-4XaJ2zQdCzROZDivEVIDPkcQn8LMFSa8kj8Gxb/Lnwzv9A8VctNZ+lfivC/sV3ivW8ElJTERXZoPBRrZKkNKow==} + engines: {node: '>=4'} + + strip-ansi@6.0.1: + resolution: {integrity: sha512-Y38VPSHcqkFrCpFnQ9vuSXmquuv5oXOKpGeT6aGrr3o3Gc9AlVa6JBfUSOCnbxGGZF+/0ooI7KrPuUSztUdU5A==} + engines: {node: '>=8'} + + strip-ansi@7.1.0: + resolution: {integrity: sha512-iq6eVVI64nQQTRYq2KtEg2d2uU7LElhTJwsH4YzIHZshxlgZms/wIc4VoDQTlG/IvVIrBKG06CrZnp0qv7hkcQ==} + engines: {node: '>=12'} + + strip-bom@3.0.0: + resolution: {integrity: sha512-vavAMRXOgBVNF6nyEEmL3DBK19iRpDcoIwW+swQ+CbGiu7lju6t+JklA1MHweoWtadgt4ISVUsXLyDq34ddcwA==} + engines: {node: '>=4'} + + strip-bom@4.0.0: + resolution: {integrity: sha512-3xurFv5tEgii33Zi8Jtp55wEIILR9eh34FAW00PZf+JnSsTmV/ioewSgQl97JHvgjoRGwPShsWm+IdrxB35d0w==} + engines: {node: '>=8'} + + strip-final-newline@2.0.0: + resolution: {integrity: sha512-BrpvfNAE3dcvq7ll3xVumzjKjZQ5tI1sEUIKr3Uoks0XUl45St3FlatVqef9prk4jRDzhW6WZg+3bk93y6pLjA==} + engines: {node: '>=6'} + + strip-final-newline@3.0.0: + resolution: {integrity: sha512-dOESqjYr96iWYylGObzd39EuNTa5VJxyvVAEm5Jnh7KGo75V43Hk1odPQkNDyXNmUR6k+gEiDVXnjB8HJ3crXw==} + engines: {node: '>=12'} + + strip-hex-prefix@1.0.0: + resolution: {integrity: sha512-q8d4ue7JGEiVcypji1bALTos+0pWtyGlivAWyPuTkHzuTCJqrK9sWxYQZUq6Nq3cuyv3bm734IhHvHtGGURU6A==} + engines: {node: '>=6.5.0', npm: '>=3'} + + strip-indent@3.0.0: + resolution: {integrity: sha512-laJTa3Jb+VQpaC6DseHhF7dXVqHTfJPCRDaEbid/drOhgitgYku/letMUqOXFoWV0zIIUbjpdH2t+tYj4bQMRQ==} + engines: {node: '>=8'} + + strip-json-comments@3.1.1: + resolution: {integrity: sha512-6fPc+R4ihwqP6N/aIv2f1gMH8lOVtWQHoqC4yK6oSDVVocumAsfCqjkXnqiYMhmMwS/mEHLp7Vehlt3ql6lEig==} + engines: {node: '>=8'} + + supports-color@3.2.3: + resolution: {integrity: sha512-Jds2VIYDrlp5ui7t8abHN2bjAu4LV/q4N2KivFPpGH0lrka0BMq/33AmECUXlKPcHigkNaqfXRENFju+rlcy+A==} + engines: {node: '>=0.8.0'} + + supports-color@5.5.0: + resolution: {integrity: sha512-QjVjwdXIt408MIiAqCX4oUKsgU2EqAGzs2Ppkm4aQYbjm+ZEWEcW4SfFNTr4uMNZma0ey4f5lgLrkB0aX0QMow==} + engines: {node: '>=4'} + + supports-color@7.2.0: + resolution: {integrity: sha512-qpCAvRl9stuOHveKsn7HncJRvv501qIacKzQlO/+Lwxc9+0q2wLyv4Dfvt80/DPn2pqOBsJdDiogXGR9+OvwRw==} + engines: {node: '>=8'} + + supports-color@8.1.1: + resolution: {integrity: sha512-MpUEN2OodtUzxvKQl72cUF7RQ5EiHsGvSsVG0ia9c5RbWGL2CI4C7EpPS8UTBIplnlzZiNuV56w+FuNxy3ty2Q==} + engines: {node: '>=10'} + + supports-preserve-symlinks-flag@1.0.0: + resolution: {integrity: sha512-ot0WnXS9fgdkgIcePe6RHNk1WA8+muPa6cSjeR3V8K27q9BB1rTE3R1p7Hv0z1ZyAc8s6Vvv8DIyWf681MAt0w==} + engines: {node: '>= 0.4'} + + sync-request@6.1.0: + resolution: {integrity: sha512-8fjNkrNlNCrVc/av+Jn+xxqfCjYaBoHqCsDz6mt030UMxJGr+GSfCV1dQt2gRtlL63+VPidwDVLr7V2OcTSdRw==} + engines: {node: '>=8.0.0'} + + sync-rpc@1.3.6: + resolution: {integrity: sha512-J8jTXuZzRlvU7HemDgHi3pGnh/rkoqR/OZSjhTyyZrEkkYQbk7Z33AXp37mkPfPpfdOuj7Ex3H/TJM1z48uPQw==} + + table-layout@1.0.2: + resolution: {integrity: sha512-qd/R7n5rQTRFi+Zf2sk5XVVd9UQl6ZkduPFC3S7WEGJAmetDTjY3qPN50eSKzwuzEyQKy5TN2TiZdkIjos2L6A==} + engines: {node: '>=8.0.0'} + + table@6.8.2: + resolution: {integrity: sha512-w2sfv80nrAh2VCbqR5AK27wswXhqcck2AhfnNW76beQXskGZ1V12GwS//yYVa3d3fcvAip2OUnbDAjW2k3v9fA==} + engines: {node: '>=10.0.0'} + + tenderly@0.9.1: + resolution: {integrity: sha512-EGhYYbOgIC0EUebrMIwCRIL9NrGrC8q3gTY/3JNSqvQrNX4RLUgMHungTG4bkgGAwJoehC57vsAeKqR1PVIyjw==} + peerDependencies: + ts-node: '*' + typescript: '*' + peerDependenciesMeta: + ts-node: + optional: true + typescript: + optional: true + + text-extensions@1.9.0: + resolution: {integrity: sha512-wiBrwC1EhBelW12Zy26JeOUkQ5mRu+5o8rpsJk5+2t+Y5vE7e842qtZDQ2g1NpX/29HdyFeJ4nSIhI47ENSxlQ==} + engines: {node: '>=0.10'} + + text-table@0.2.0: + resolution: {integrity: sha512-N+8UisAXDGk8PFXP4HAzVR9nbfmVJ3zYLAWiTIoqC5v5isinhr+r5uaO8+7r3BMfuNIufIsA7RdpVgacC2cSpw==} + + then-request@6.0.2: + resolution: {integrity: sha512-3ZBiG7JvP3wbDzA9iNY5zJQcHL4jn/0BWtXIkagfz7QgOL/LqjCEOBQuJNZfu0XYnv5JhKh+cDxCPM4ILrqruA==} + engines: {node: '>=6.0.0'} + + through2@4.0.2: + resolution: {integrity: sha512-iOqSav00cVxEEICeD7TjLB1sueEL+81Wpzp2bY17uZjZN0pWZPuo4suZ/61VujxmqSGFfgOcNuTZ85QJwNZQpw==} + + through@2.3.8: + resolution: {integrity: sha512-w89qg7PI8wAdvX60bMDP+bFoD5Dvhm9oLheFp5O4a2QF0cSBGsBX4qZmadPMvVqlLJBBci+WqGGOAPvcDeNSVg==} + + tmp@0.0.33: + resolution: {integrity: sha512-jRCJlojKnZ3addtTOjdIqoRuPEKBvNXcGYqzO6zWZX8KfKEpnGY5jfggJQ3EjKuu8D4bJRr0y+cYJFmYbImXGw==} + engines: {node: '>=0.6.0'} + + to-fast-properties@2.0.0: + resolution: {integrity: sha512-/OaKK0xYrs3DmxRYqL/yDc+FxFUVYhDlXMhRmv3z915w2HF1tnN1omB354j8VUGO/hbRzyD6Y3sA7v7GS/ceog==} + engines: {node: '>=4'} + + to-regex-range@5.0.1: + resolution: {integrity: sha512-65P7iz6X5yEr1cwcgvQxbbIw7Uk3gOy5dIdtZ4rDveLqhrdJP+Li/Hx6tyK0NEb+2GCyneCMJiGqrADCSNk8sQ==} + engines: {node: '>=8.0'} + + toidentifier@1.0.1: + resolution: {integrity: sha512-o5sSPKEkg/DIQNmH43V0/uerLrpzVedkUh8tGNvaeXpfpuwjKenlSox/2O/BTlZUtEe+JG7s5YhEz608PlAHRA==} + engines: {node: '>=0.6'} + + tr46@0.0.3: + resolution: {integrity: sha512-N3WMsuqV66lT30CrXNbEjx4GEwlow3v6rr4mCcv6prnfwhS01rkgyFdjPNBYd9br7LpXV1+Emh01fHnq2Gdgrw==} + + trim-newlines@3.0.1: + resolution: {integrity: sha512-c1PTsA3tYrIsLGkJkzHF+w9F2EyxfXGo4UyJc4pFL++FMjnq0HJS69T3M7d//gKrFKwy429bouPescbjecU+Zw==} + engines: {node: '>=8'} + + ts-api-utils@1.3.0: + resolution: {integrity: sha512-UQMIo7pb8WRomKR1/+MFVLTroIvDVtMX3K6OUir8ynLyzB8Jeriont2bTAtmNPa1ekAgN7YPDyf6V+ygrdU+eQ==} + engines: {node: '>=16'} + peerDependencies: + typescript: '>=4.2.0' + + ts-command-line-args@2.5.1: + resolution: {integrity: sha512-H69ZwTw3rFHb5WYpQya40YAX2/w7Ut75uUECbgBIsLmM+BNuYnxsltfyyLMxy6sEeKxgijLTnQtLd0nKd6+IYw==} + hasBin: true + + ts-essentials@7.0.3: + resolution: {integrity: sha512-8+gr5+lqO3G84KdiTSMRLtuyJ+nTBVRKuCrK4lidMPdVeEp0uqC875uE5NMcaA7YYMN7XsNiFQuMvasF8HT/xQ==} + peerDependencies: + typescript: '>=3.7.0' + + ts-node@10.9.2: + resolution: {integrity: sha512-f0FFpIdcHgn8zcPSbf1dRevwt047YMnaiJM3u2w2RewrB+fob/zePZcrOyQoLMMO7aBIddLcQIEK5dYjkLnGrQ==} + hasBin: true + peerDependencies: + '@swc/core': '>=1.2.50' + '@swc/wasm': '>=1.2.50' + '@types/node': '*' + typescript: '>=2.7' + peerDependenciesMeta: + '@swc/core': + optional: true + '@swc/wasm': + optional: true + + tslib@1.14.1: + resolution: {integrity: sha512-Xni35NKzjgMrwevysHTCArtLDpPvye8zV/0E4EyYn43P7/7qvQwPh9BGkHewbMulVntbigmcT7rdX3BNo9wRJg==} + + tslib@2.4.0: + resolution: {integrity: sha512-d6xOpEDfsi2CZVlPQzGeux8XMwLT9hssAsaPYExaQMuYskwb+x1x7J371tWlbBdWHroy99KnVB6qIkUbs5X3UQ==} + + tslib@2.7.0: + resolution: {integrity: sha512-gLXCKdN1/j47AiHiOkJN69hJmcbGTHI0ImLmbYLHykhgeN0jVGola9yVjFgzCUklsZQMW55o+dW7IXv3RCXDzA==} + + tslog@4.9.3: + resolution: {integrity: sha512-oDWuGVONxhVEBtschLf2cs/Jy8i7h1T+CpdkTNWQgdAF7DhRo2G8vMCgILKe7ojdEkLhICWgI1LYSSKaJsRgcw==} + engines: {node: '>=16'} + + tsort@0.0.1: + resolution: {integrity: sha512-Tyrf5mxF8Ofs1tNoxA13lFeZ2Zrbd6cKbuH3V+MQ5sb6DtBj5FjrXVsRWT8YvNAQTqNoz66dz1WsbigI22aEnw==} + + tweetnacl-util@0.15.1: + resolution: {integrity: sha512-RKJBIj8lySrShN4w6i/BonWp2Z/uxwC3h4y7xsRrpP59ZboCd0GpEVsOnMDYLMmKBpYhb5TgHzZXy7wTfYFBRw==} + + tweetnacl@1.0.3: + resolution: {integrity: sha512-6rt+RN7aOi1nGMyC4Xa5DdYiukl2UWCbcJft7YhxReBGQD7OAM8Pbxw6YMo4r2diNEA8FEmu32YOn9rhaiE5yw==} + + type-check@0.3.2: + resolution: {integrity: sha512-ZCmOJdvOWDBYJlzAoFkC+Q0+bUyEOS1ltgp1MGU03fqHG+dbi9tBFU2Rd9QKiDZFAYrhPh2JUf7rZRIuHRKtOg==} + engines: {node: '>= 0.8.0'} + + type-check@0.4.0: + resolution: {integrity: sha512-XleUoc9uwGXqjWwXaUTZAmzMcFZ5858QA2vvx1Ur5xIcixXIP+8LnFDgRplU30us6teqdlskFfu+ae4K79Ooew==} + engines: {node: '>= 0.8.0'} + + type-detect@4.1.0: + resolution: {integrity: sha512-Acylog8/luQ8L7il+geoSxhEkazvkslg7PSNKOX59mbB9cOveP5aq9h74Y7YU8yDpJwetzQQrfIwtf4Wp4LKcw==} + engines: {node: '>=4'} + + type-fest@0.18.1: + resolution: {integrity: sha512-OIAYXk8+ISY+qTOwkHtKqzAuxchoMiD9Udx+FSGQDuiRR+PJKJHc2NJAXlbhkGwTt/4/nKZxELY1w3ReWOL8mw==} + engines: {node: '>=10'} + + type-fest@0.20.2: + resolution: {integrity: sha512-Ne+eE4r0/iWnpAxD852z3A+N0Bt5RN//NjJwRd2VFHEmrywxf5vsZlh4R6lixl6B+wz/8d+maTSAkN1FIkI3LQ==} + engines: {node: '>=10'} + + type-fest@0.21.3: + resolution: {integrity: sha512-t0rzBq87m3fVcduHDUFhKmyyX+9eo6WQjZvf51Ea/M0Q7+T374Jp1aUiyUl0GKxp8M/OETVHSDvmkyPgvX+X2w==} + engines: {node: '>=10'} + + type-fest@0.6.0: + resolution: {integrity: sha512-q+MB8nYR1KDLrgr4G5yemftpMC7/QLqVndBmEEdqzmNj5dcFOO4Oo8qlwZE3ULT3+Zim1F8Kq4cBnikNhlCMlg==} + engines: {node: '>=8'} + + type-fest@0.7.1: + resolution: {integrity: sha512-Ne2YiiGN8bmrmJJEuTWTLJR32nh/JdL1+PSicowtNb0WFpn59GK8/lfD61bVtzguz7b3PBt74nxpv/Pw5po5Rg==} + engines: {node: '>=8'} + + type-fest@0.8.1: + resolution: {integrity: sha512-4dbzIzqvjtgiM5rw1k5rEHtBANKmdudhGyBEajN01fEyhaAIhsoKNy6y7+IN93IfpFtwY9iqi7kD+xwKhQsNJA==} + engines: {node: '>=8'} + + type-fest@1.4.0: + resolution: {integrity: sha512-yGSza74xk0UG8k+pLh5oeoYirvIiWo5t0/o3zHHAO2tRDiZcxWP7fywNlXhqb6/r6sWvwi+RsyQMWhVLe4BVuA==} + engines: {node: '>=10'} + + typechain@8.3.2: + resolution: {integrity: sha512-x/sQYr5w9K7yv3es7jo4KTX05CLxOf7TRWwoHlrjRh8H82G64g+k7VuWPJlgMo6qrjfCulOdfBjiaDtmhFYD/Q==} + hasBin: true + peerDependencies: + typescript: '>=4.3.0' + + typedarray@0.0.6: + resolution: {integrity: sha512-/aCDEGatGvZ2BIk+HmLf4ifCJFwvKFNb9/JeZPMulfgFracn9QFcAf5GO8B/mweUjSoblS5In0cWhqpfs/5PQA==} + + typescript@5.6.2: + resolution: {integrity: sha512-NW8ByodCSNCwZeghjN3o+JX5OFH0Ojg6sadjEKY4huZ52TqbJTJnDo5+Tw98lSy63NZvi4n+ez5m2u5d4PkZyw==} + engines: {node: '>=14.17'} + hasBin: true + + typical@4.0.0: + resolution: {integrity: sha512-VAH4IvQ7BDFYglMd7BPRDfLgxZZX4O4TFcRDA6EN5X7erNJJq+McIEp8np9aVtxrCJ6qx4GTYVfOWNjcqwZgRw==} + engines: {node: '>=8'} + + typical@5.2.0: + resolution: {integrity: sha512-dvdQgNDNJo+8B2uBQoqdb11eUCE1JQXhvjC/CZtgvZseVd5TYMXnq0+vuUemXbd/Se29cTaUuPX3YIc2xgbvIg==} + engines: {node: '>=8'} + + uglify-js@3.19.3: + resolution: {integrity: sha512-v3Xu+yuwBXisp6QYTcH4UbH+xYJXqnq2m/LtQVWKWzYc1iehYnLixoQDN9FH6/j9/oybfd6W9Ghwkl8+UMKTKQ==} + engines: {node: '>=0.8.0'} + hasBin: true + + undici-types@5.26.5: + resolution: {integrity: sha512-JlCMO+ehdEIKqlFxk6IfVoAUVmgz7cU7zD/h9XZ0qzeosSHmUJVOzSQvvYSYWXkFXC+IfLKSIffhv0sVZup6pA==} + + undici@5.28.4: + resolution: {integrity: sha512-72RFADWFqKmUb2hmmvNODKL3p9hcB6Gt2DOQMis1SEBaV6a4MH8soBvzg+95CYhCKPFedut2JY9bMfrDl9D23g==} + engines: {node: '>=14.0'} + + undici@6.19.8: + resolution: {integrity: sha512-U8uCCl2x9TK3WANvmBavymRzxbfFYG+tAu+fgx3zxQy3qdagQqBLwJVrdyO1TBfUXvfKveMKJZhpvUYoOjM+4g==} + engines: {node: '>=18.17'} + + unfetch@4.2.0: + resolution: {integrity: sha512-F9p7yYCn6cIW9El1zi0HI6vqpeIvBsr3dSuRO6Xuppb1u5rXpCPmMvLSyECLhybr9isec8Ohl0hPekMVrEinDA==} + + universalify@0.1.2: + resolution: {integrity: sha512-rBJeI5CXAlmy1pV+617WB9J63U6XcazHHF2f2dbJix4XzpUF0RS3Zbj0FGIOCAva5P/d/GBOYaACQ1w+0azUkg==} + engines: {node: '>= 4.0.0'} + + universalify@2.0.1: + resolution: {integrity: sha512-gptHNQghINnc/vTGIk0SOFGFNXw7JVrlRUtConJRlvaw6DuX0wO5Jeko9sWrMBhh+PsYAZ7oXAiOnf/UKogyiw==} + engines: {node: '>= 10.0.0'} + + unpipe@1.0.0: + resolution: {integrity: sha512-pjy2bYhSsufwWlKwPc+l3cN7+wuJlK6uz0YdJEOlQDbl6jo/YlPi4mb8agUkVC8BF7V8NuzeyPNqRksA3hztKQ==} + engines: {node: '>= 0.8'} + + update-browserslist-db@1.1.0: + resolution: {integrity: sha512-EdRAaAyk2cUE1wOf2DkEhzxqOQvFOoRJFNS6NeyJ01Gp2beMRpBAINjM2iDXE3KCuKhwnvHIQCJm6ThL2Z+HzQ==} + hasBin: true + peerDependencies: + browserslist: '>= 4.21.0' + + uri-js@4.4.1: + resolution: {integrity: sha512-7rKUyy33Q1yc98pQ1DAmLtwX109F7TIfWlW1Ydo8Wl1ii1SeHieeh0HHfPeL2fMXK6z0s8ecKs9frCuLJvndBg==} + + utf8@3.0.0: + resolution: {integrity: sha512-E8VjFIQ/TyQgp+TZfS6l8yp/xWppSAHzidGiRrqe4bK4XP9pTRyKFgGJpO3SN7zdX4DeomTrwaseCHovfpFcqQ==} + + util-deprecate@1.0.2: + resolution: {integrity: sha512-EPD5q1uXyFxJpCrLnCc1nHnq3gOa6DZBocAIiI2TaSCA7VCJ1UJDMagCzIkXNsUYfD1daK//LTEQ8xiIbrHtcw==} + + uuid@8.3.2: + resolution: {integrity: sha512-+NYs2QeMWy+GWFOEm9xnn6HCDp0l7QBD7ml8zLUmJ+93Q5NF0NocErnwkTkXVFNiX3/fpC6afS8Dhb/gz7R7eg==} + hasBin: true + + v8-compile-cache-lib@3.0.1: + resolution: {integrity: sha512-wa7YjyUGfNZngI/vtK0UHAN+lgDCxBPCylVXGp0zu59Fz5aiGtNXaq3DhIov063MorB+VfufLh3JlF2KdTK3xg==} + + validate-npm-package-license@3.0.4: + resolution: {integrity: sha512-DpKm2Ui/xN7/HQKCtpZxoRWBhZ9Z0kqtygG8XCgNQ8ZlDnxuQmWhj566j8fN4Cu3/JmbhsDo7fcAJq4s9h27Ew==} + + viem@2.21.5: + resolution: {integrity: sha512-MFuoeGA8hRJJ0CknSuKYZjVaxSy5hyzu9MCArOANz3Iq5RITBJNIhM+m6TNvO9I2AxCSF3+PZObjbrLVg7cX2w==} + peerDependencies: + typescript: '>=5.0.4' + peerDependenciesMeta: + typescript: + optional: true + + wcwidth@1.0.1: + resolution: {integrity: sha512-XHPEwS0q6TaxcvG85+8EYkbiCux2XtWG2mkc47Ng2A77BQu9+DqIOJldST4HgPkuea7dvKSj5VgX3P1d4rW8Tg==} + + web3-utils@1.10.4: + resolution: {integrity: sha512-tsu8FiKJLk2PzhDl9fXbGUWTkkVXYhtTA+SmEFkKft+9BgwLxfCRpU96sWv7ICC8zixBNd3JURVoiR3dUXgP8A==} + engines: {node: '>=8.0.0'} + + webauthn-p256@0.0.5: + resolution: {integrity: sha512-drMGNWKdaixZNobeORVIqq7k5DsRC9FnG201K2QjeOoQLmtSDaSsVZdkg6n5jUALJKcAG++zBPJXmv6hy0nWFg==} + + webidl-conversions@3.0.1: + resolution: {integrity: sha512-2JAn3z8AR6rjK8Sm8orRC0h/bcl/DqL7tRPdGZ4I1CjdF+EaMLmYxBHyXuKL849eucPFhvBoxMsflfOb8kxaeQ==} + + whatwg-url@5.0.0: + resolution: {integrity: sha512-saE57nupxk6v3HY35+jzBwYa0rKSy0XR8JSxZPwgLr7ys0IBzhGviA1/TUGJLmSVqs8pb9AnvICXEuOHLprYTw==} + + which@1.3.1: + resolution: {integrity: sha512-HxJdYWq1MTIQbJ3nw0cqssHoTNU267KlrDuGZ1WYlxDStUtKUhOaJmh112/TZmHxxUfuJqPXSOm7tDyas0OSIQ==} + hasBin: true + + which@2.0.2: + resolution: {integrity: sha512-BLI3Tl1TW3Pvl70l3yq3Y64i+awpwXqsGBYWkkqMtnbXgrMD+yj7rhW0kuEDxzJaYXGjEW5ogapKNMEKNMjibA==} + engines: {node: '>= 8'} + hasBin: true + + widest-line@3.1.0: + resolution: {integrity: sha512-NsmoXalsWVDMGupxZ5R08ka9flZjjiLvHVAWYOKtiKM8ujtZWr9cRffak+uSE48+Ob8ObalXpwyeUiyDD6QFgg==} + engines: {node: '>=8'} + + word-wrap@1.2.5: + resolution: {integrity: sha512-BN22B5eaMMI9UMtjrGd5g5eCYPpCPDUy0FJXbYsaT5zYxjFOckS53SQDE3pWkVoWpHXVb3BrYcEN4Twa55B5cA==} + engines: {node: '>=0.10.0'} + + wordwrap@1.0.0: + resolution: {integrity: sha512-gvVzJFlPycKc5dZN4yPkP8w7Dc37BtP1yczEneOb4uq34pXZcvrtRTmWV8W+Ume+XCxKgbjM+nevkyFPMybd4Q==} + + wordwrapjs@4.0.1: + resolution: {integrity: sha512-kKlNACbvHrkpIw6oPeYDSmdCTu2hdMHoyXLTcUKala++lx5Y+wjJ/e474Jqv5abnVmwxw08DiTuHmw69lJGksA==} + engines: {node: '>=8.0.0'} + + workerpool@6.5.1: + resolution: {integrity: sha512-Fs4dNYcsdpYSAfVxhnl1L5zTksjvOJxtC5hzMNl+1t9B8hTJTdKDyZ5ju7ztgPy+ft9tBFXoOlDNiOT9WUXZlA==} + + wrap-ansi@7.0.0: + resolution: {integrity: sha512-YVGIj2kamLSTxw6NsZjoBxfSwsn0ycdesmc4p+Q21c5zPuZ1pl+NfxVdxPtdHvmNVOQ6XSYG4AUtyt/Fi7D16Q==} + engines: {node: '>=10'} + + wrap-ansi@8.1.0: + resolution: {integrity: sha512-si7QWI6zUMq56bESFvagtmzMdGOtoxfR+Sez11Mobfc7tm+VkUckk9bW2UeffTGVUbOksxmSw0AA2gs8g71NCQ==} + engines: {node: '>=12'} + + wrappy@1.0.2: + resolution: {integrity: sha512-l4Sp/DRseor9wL6EvV2+TuQn63dMkPjZ/sp9XkghTEbV9KlPS1xUsZ3u7/IQO4wxtcFB4bgpQPRcR3QCvezPcQ==} + + ws@7.4.6: + resolution: {integrity: sha512-YmhHDO4MzaDLB+M9ym/mDA5z0naX8j7SIlT8f8z+I0VtzsRbekxEutHSme7NPS2qE8StCYQNUnfWdXta/Yu85A==} + engines: {node: '>=8.3.0'} + peerDependencies: + bufferutil: ^4.0.1 + utf-8-validate: ^5.0.2 + peerDependenciesMeta: + bufferutil: + optional: true + utf-8-validate: + optional: true + + ws@7.5.10: + resolution: {integrity: sha512-+dbF1tHwZpXcbOJdVOkzLDxZP1ailvSxM6ZweXTegylPny803bFhA+vqBYw4s31NSAk4S2Qz+AKXK9a4wkdjcQ==} + engines: {node: '>=8.3.0'} + peerDependencies: + bufferutil: ^4.0.1 + utf-8-validate: ^5.0.2 + peerDependenciesMeta: + bufferutil: + optional: true + utf-8-validate: + optional: true + + ws@8.17.1: + resolution: {integrity: sha512-6XQFvXTkbfUOZOKKILFG1PDK2NDQs4azKQl26T0YS5CxqWLgXajbPZ+h4gZekJyRqFU8pvnbAbbs/3TgRPy+GQ==} + engines: {node: '>=10.0.0'} + peerDependencies: + bufferutil: ^4.0.1 + utf-8-validate: '>=5.0.2' + peerDependenciesMeta: + bufferutil: + optional: true + utf-8-validate: + optional: true + + xdeployer@2.2.2: + resolution: {integrity: sha512-CmkADnwn9M7J33Rrb1sbaI5mBaXrRr2kLEw5W6QMeTJkXw57ae7/IIBYHDbuFLu7L60J3ZF21KdpHjmSMkUsVQ==} + engines: {node: '>=14.0.0'} + peerDependencies: + '@nomicfoundation/hardhat-ethers': ^3.0.5 + ethers: ^6.9.0 + hardhat: ^2.19.2 + + y18n@5.0.8: + resolution: {integrity: sha512-0pfFzegeDWJHJIAmTLRP2DwHjdF5s7jo9tuztdQxAhINCdvS+3nGINqPd00AphqJR/0LhANUS6/+7SCb98YOfA==} + engines: {node: '>=10'} + + yallist@3.1.1: + resolution: {integrity: sha512-a4UGQaWPH59mOXUYnAG2ewncQS4i4F43Tv3JoAM+s2VDAmS9NsK8GpDMLrCHPksFT7h3K6TOoUNn2pb7RoXx4g==} + + yallist@4.0.0: + resolution: {integrity: sha512-3wdGidZyq5PB084XLES5TpOSRA3wjXAlIWMhum2kRcv/41Sn2emQ0dycQW4uZXLejwKvg6EsvbdlVL+FYEct7A==} + + yaml@2.3.1: + resolution: {integrity: sha512-2eHWfjaoXgTBC2jNM1LRef62VQa0umtvRiDSk6HSzW7RvS5YtkabJrwYLLEKWBc8a5U2PTSCs+dJjUTJdlHsWQ==} + engines: {node: '>= 14'} + + yargs-parser@20.2.9: + resolution: {integrity: sha512-y11nGElTIV+CT3Zv9t7VKl+Q3hTQoT9a1Qzezhhl6Rp21gJ/IVTW7Z3y9EWXhuUBC2Shnf+DX0antecpAwSP8w==} + engines: {node: '>=10'} + + yargs-parser@21.1.1: + resolution: {integrity: sha512-tVpsJW7DdjecAiFpbIB1e3qxIQsE6NoPc5/eTdrbbIC4h0LVsWhnoa3g+m2HclBIujHzsxZ4VJVA+GUuc2/LBw==} + engines: {node: '>=12'} + + yargs-unparser@2.0.0: + resolution: {integrity: sha512-7pRTIA9Qc1caZ0bZ6RYRGbHJthJWuakf+WmHK0rVeLkNrrGhfoabBNdue6kdINI6r4if7ocq9aD/n7xwKOdzOA==} + engines: {node: '>=10'} + + yargs@16.2.0: + resolution: {integrity: sha512-D1mvvtDG0L5ft/jGWkLpG1+m0eQxOfaBvTNELraWj22wSVUMWxZUvYgJYcKh6jGGIkJFhH4IZPQhR4TKpc8mBw==} + engines: {node: '>=10'} + + yargs@17.7.2: + resolution: {integrity: sha512-7dSzzRQ++CKnNI/krKnYRV7JKKPUXMEh61soaHKg9mrWEhzFWhFnxPxGl+69cD1Ou63C13NUPCnmIcrvqCuM6w==} + engines: {node: '>=12'} + + yn@3.1.1: + resolution: {integrity: sha512-Ux4ygGWsu2c7isFWe8Yu1YluJmqVhxqK2cLXNQA5AcC3QfbGNpM7fu0Y8b/z16pXLnFxZYvWhd3fhBY9DLmC6Q==} + engines: {node: '>=6'} + + yocto-queue@0.1.0: + resolution: {integrity: sha512-rVksvsnNCdJ/ohGc6xgPwyN8eheCxsiLM8mxuE/t/mOVqJewPuO1miLpTHQiRgTKCLexL4MeAFVagts7HmNZ2Q==} + engines: {node: '>=10'} + + zksync-web3@0.14.4: + resolution: {integrity: sha512-kYehMD/S6Uhe1g434UnaMN+sBr9nQm23Ywn0EUP5BfQCsbjcr3ORuS68PosZw8xUTu3pac7G6YMSnNHk+fwzvg==} + deprecated: This package has been deprecated in favor of zksync-ethers@5.0.0 + peerDependencies: + ethers: ^5.7.0 + +snapshots: + + '@adraffy/ens-normalize@1.10.0': {} + + '@adraffy/ens-normalize@1.10.1': {} + + '@ampproject/remapping@2.3.0': + dependencies: + '@jridgewell/gen-mapping': 0.3.5 + '@jridgewell/trace-mapping': 0.3.25 + + '@aws-crypto/sha256-js@1.2.2': + dependencies: + '@aws-crypto/util': 1.2.2 + '@aws-sdk/types': 3.649.0 + tslib: 1.14.1 + + '@aws-crypto/util@1.2.2': + dependencies: + '@aws-sdk/types': 3.649.0 + '@aws-sdk/util-utf8-browser': 3.259.0 + tslib: 1.14.1 + + '@aws-sdk/types@3.649.0': + dependencies: + '@smithy/types': 3.4.0 + tslib: 2.7.0 + + '@aws-sdk/util-utf8-browser@3.259.0': + dependencies: + tslib: 2.7.0 + + '@babel/code-frame@7.24.7': + dependencies: + '@babel/highlight': 7.24.7 + picocolors: 1.1.0 + + '@babel/compat-data@7.25.4': {} + + '@babel/core@7.17.8': + dependencies: + '@ampproject/remapping': 2.3.0 + '@babel/code-frame': 7.24.7 + '@babel/generator': 7.17.7 + '@babel/helper-compilation-targets': 7.25.2 + '@babel/helper-module-transforms': 7.25.2(@babel/core@7.17.8) + '@babel/helpers': 7.25.6 + '@babel/parser': 7.18.9 + '@babel/template': 7.25.0 + '@babel/traverse': 7.17.3 + '@babel/types': 7.17.0 + convert-source-map: 1.9.0 + debug: 4.3.7(supports-color@8.1.1) + gensync: 1.0.0-beta.2 + json5: 2.2.3 + semver: 6.3.1 + transitivePeerDependencies: + - supports-color + + '@babel/generator@7.17.7': + dependencies: + '@babel/types': 7.17.0 + jsesc: 2.5.2 + source-map: 0.5.7 + + '@babel/generator@7.25.6': + dependencies: + '@babel/types': 7.25.6 + '@jridgewell/gen-mapping': 0.3.5 + '@jridgewell/trace-mapping': 0.3.25 + jsesc: 2.5.2 + + '@babel/helper-compilation-targets@7.25.2': + dependencies: + '@babel/compat-data': 7.25.4 + '@babel/helper-validator-option': 7.24.8 + browserslist: 4.23.3 + lru-cache: 5.1.1 + semver: 6.3.1 + + '@babel/helper-environment-visitor@7.24.7': + dependencies: + '@babel/types': 7.25.6 + + '@babel/helper-function-name@7.24.7': + dependencies: + '@babel/template': 7.25.0 + '@babel/types': 7.25.6 + + '@babel/helper-hoist-variables@7.24.7': + dependencies: + '@babel/types': 7.25.6 + + '@babel/helper-module-imports@7.24.7': + dependencies: + '@babel/traverse': 7.25.6 + '@babel/types': 7.25.6 + transitivePeerDependencies: + - supports-color + + '@babel/helper-module-transforms@7.25.2(@babel/core@7.17.8)': + dependencies: + '@babel/core': 7.17.8 + '@babel/helper-module-imports': 7.24.7 + '@babel/helper-simple-access': 7.24.7 + '@babel/helper-validator-identifier': 7.24.7 + '@babel/traverse': 7.25.6 + transitivePeerDependencies: + - supports-color + + '@babel/helper-simple-access@7.24.7': + dependencies: + '@babel/traverse': 7.25.6 + '@babel/types': 7.25.6 + transitivePeerDependencies: + - supports-color + + '@babel/helper-split-export-declaration@7.24.7': + dependencies: + '@babel/types': 7.25.6 + + '@babel/helper-string-parser@7.24.8': {} + + '@babel/helper-validator-identifier@7.24.7': {} + + '@babel/helper-validator-option@7.24.8': {} + + '@babel/helpers@7.25.6': + dependencies: + '@babel/template': 7.25.0 + '@babel/types': 7.25.6 + + '@babel/highlight@7.24.7': + dependencies: + '@babel/helper-validator-identifier': 7.24.7 + chalk: 2.4.2 + js-tokens: 4.0.0 + picocolors: 1.1.0 + + '@babel/parser@7.18.9': + dependencies: + '@babel/types': 7.17.0 + + '@babel/parser@7.25.6': + dependencies: + '@babel/types': 7.25.6 + + '@babel/template@7.25.0': + dependencies: + '@babel/code-frame': 7.24.7 + '@babel/parser': 7.25.6 + '@babel/types': 7.25.6 + + '@babel/traverse@7.17.3': + dependencies: + '@babel/code-frame': 7.24.7 + '@babel/generator': 7.17.7 + '@babel/helper-environment-visitor': 7.24.7 + '@babel/helper-function-name': 7.24.7 + '@babel/helper-hoist-variables': 7.24.7 + '@babel/helper-split-export-declaration': 7.24.7 + '@babel/parser': 7.18.9 + '@babel/types': 7.17.0 + debug: 4.3.7(supports-color@8.1.1) + globals: 11.12.0 + transitivePeerDependencies: + - supports-color + + '@babel/traverse@7.25.6': + dependencies: + '@babel/code-frame': 7.24.7 + '@babel/generator': 7.25.6 + '@babel/parser': 7.25.6 + '@babel/template': 7.25.0 + '@babel/types': 7.25.6 + debug: 4.3.7(supports-color@8.1.1) + globals: 11.12.0 + transitivePeerDependencies: + - supports-color + + '@babel/types@7.17.0': + dependencies: + '@babel/helper-validator-identifier': 7.24.7 + to-fast-properties: 2.0.0 + + '@babel/types@7.25.6': + dependencies: + '@babel/helper-string-parser': 7.24.8 + '@babel/helper-validator-identifier': 7.24.7 + to-fast-properties: 2.0.0 + + '@chainlink/contracts@0.8.0(ethers@6.13.2)': + dependencies: + '@eth-optimism/contracts': 0.5.40(ethers@6.13.2) + '@openzeppelin/contracts': 4.3.3 + '@openzeppelin/contracts-upgradeable-4.7.3': '@openzeppelin/contracts-upgradeable@4.7.3' + '@openzeppelin/contracts-v0.7': '@openzeppelin/contracts@3.4.2' + transitivePeerDependencies: + - bufferutil + - ethers + - utf-8-validate + + '@colors/colors@1.5.0': + optional: true + + '@commitlint/cli@17.8.1(@swc/core@1.7.26)': + dependencies: + '@commitlint/format': 17.8.1 + '@commitlint/lint': 17.8.1 + '@commitlint/load': 17.8.1(@swc/core@1.7.26) + '@commitlint/read': 17.8.1 + '@commitlint/types': 17.8.1 + execa: 5.1.1 + lodash.isfunction: 3.0.9 + resolve-from: 5.0.0 + resolve-global: 1.0.0 + yargs: 17.7.2 + transitivePeerDependencies: + - '@swc/core' + - '@swc/wasm' + + '@commitlint/config-conventional@17.8.1': + dependencies: + conventional-changelog-conventionalcommits: 6.1.0 + + '@commitlint/config-validator@17.8.1': + dependencies: + '@commitlint/types': 17.8.1 + ajv: 8.17.1 + + '@commitlint/config-validator@19.5.0': + dependencies: + '@commitlint/types': 19.5.0 + ajv: 8.17.1 + optional: true + + '@commitlint/ensure@17.8.1': + dependencies: + '@commitlint/types': 17.8.1 + lodash.camelcase: 4.3.0 + lodash.kebabcase: 4.1.1 + lodash.snakecase: 4.1.1 + lodash.startcase: 4.4.0 + lodash.upperfirst: 4.3.1 + + '@commitlint/execute-rule@17.8.1': {} + + '@commitlint/execute-rule@19.5.0': + optional: true + + '@commitlint/format@17.8.1': + dependencies: + '@commitlint/types': 17.8.1 + chalk: 4.1.2 + + '@commitlint/is-ignored@17.8.1': + dependencies: + '@commitlint/types': 17.8.1 + semver: 7.5.4 + + '@commitlint/lint@17.8.1': + dependencies: + '@commitlint/is-ignored': 17.8.1 + '@commitlint/parse': 17.8.1 + '@commitlint/rules': 17.8.1 + '@commitlint/types': 17.8.1 + + '@commitlint/load@17.8.1(@swc/core@1.7.26)': + dependencies: + '@commitlint/config-validator': 17.8.1 + '@commitlint/execute-rule': 17.8.1 + '@commitlint/resolve-extends': 17.8.1 + '@commitlint/types': 17.8.1 + '@types/node': 20.5.1 + chalk: 4.1.2 + cosmiconfig: 8.3.6(typescript@5.6.2) + cosmiconfig-typescript-loader: 4.4.0(@types/node@20.5.1)(cosmiconfig@8.3.6(typescript@5.6.2))(ts-node@10.9.2(@swc/core@1.7.26)(@types/node@20.5.1)(typescript@5.6.2))(typescript@5.6.2) + lodash.isplainobject: 4.0.6 + lodash.merge: 4.6.2 + lodash.uniq: 4.5.0 + resolve-from: 5.0.0 + ts-node: 10.9.2(@swc/core@1.7.26)(@types/node@20.5.1)(typescript@5.6.2) + typescript: 5.6.2 + transitivePeerDependencies: + - '@swc/core' + - '@swc/wasm' + + '@commitlint/load@19.5.0(@types/node@18.19.50)(typescript@5.6.2)': + dependencies: + '@commitlint/config-validator': 19.5.0 + '@commitlint/execute-rule': 19.5.0 + '@commitlint/resolve-extends': 19.5.0 + '@commitlint/types': 19.5.0 + chalk: 5.3.0 + cosmiconfig: 9.0.0(typescript@5.6.2) + cosmiconfig-typescript-loader: 5.0.0(@types/node@18.19.50)(cosmiconfig@9.0.0(typescript@5.6.2))(typescript@5.6.2) + lodash.isplainobject: 4.0.6 + lodash.merge: 4.6.2 + lodash.uniq: 4.5.0 + transitivePeerDependencies: + - '@types/node' + - typescript + optional: true + + '@commitlint/message@17.8.1': {} + + '@commitlint/parse@17.8.1': + dependencies: + '@commitlint/types': 17.8.1 + conventional-changelog-angular: 6.0.0 + conventional-commits-parser: 4.0.0 + + '@commitlint/read@17.8.1': + dependencies: + '@commitlint/top-level': 17.8.1 + '@commitlint/types': 17.8.1 + fs-extra: 11.2.0 + git-raw-commits: 2.0.11 + minimist: 1.2.8 + + '@commitlint/resolve-extends@17.8.1': + dependencies: + '@commitlint/config-validator': 17.8.1 + '@commitlint/types': 17.8.1 + import-fresh: 3.3.0 + lodash.mergewith: 4.6.2 + resolve-from: 5.0.0 + resolve-global: 1.0.0 + + '@commitlint/resolve-extends@19.5.0': + dependencies: + '@commitlint/config-validator': 19.5.0 + '@commitlint/types': 19.5.0 + global-directory: 4.0.1 + import-meta-resolve: 4.1.0 + lodash.mergewith: 4.6.2 + resolve-from: 5.0.0 + optional: true + + '@commitlint/rules@17.8.1': + dependencies: + '@commitlint/ensure': 17.8.1 + '@commitlint/message': 17.8.1 + '@commitlint/to-lines': 17.8.1 + '@commitlint/types': 17.8.1 + execa: 5.1.1 + + '@commitlint/to-lines@17.8.1': {} + + '@commitlint/top-level@17.8.1': + dependencies: + find-up: 5.0.0 + + '@commitlint/types@17.8.1': + dependencies: + chalk: 4.1.2 + + '@commitlint/types@19.5.0': + dependencies: + '@types/conventional-commits-parser': 5.0.0 + chalk: 5.3.0 + optional: true + + '@cspotcode/source-map-support@0.8.1': + dependencies: + '@jridgewell/trace-mapping': 0.3.9 + + '@esbuild/aix-ppc64@0.23.1': + optional: true + + '@esbuild/android-arm64@0.23.1': + optional: true + + '@esbuild/android-arm@0.23.1': + optional: true + + '@esbuild/android-x64@0.23.1': + optional: true + + '@esbuild/darwin-arm64@0.23.1': + optional: true + + '@esbuild/darwin-x64@0.23.1': + optional: true + + '@esbuild/freebsd-arm64@0.23.1': + optional: true + + '@esbuild/freebsd-x64@0.23.1': + optional: true + + '@esbuild/linux-arm64@0.23.1': + optional: true + + '@esbuild/linux-arm@0.23.1': + optional: true + + '@esbuild/linux-ia32@0.23.1': + optional: true + + '@esbuild/linux-loong64@0.23.1': + optional: true + + '@esbuild/linux-mips64el@0.23.1': + optional: true + + '@esbuild/linux-ppc64@0.23.1': + optional: true + + '@esbuild/linux-riscv64@0.23.1': + optional: true + + '@esbuild/linux-s390x@0.23.1': + optional: true + + '@esbuild/linux-x64@0.23.1': + optional: true + + '@esbuild/netbsd-x64@0.23.1': + optional: true + + '@esbuild/openbsd-arm64@0.23.1': + optional: true + + '@esbuild/openbsd-x64@0.23.1': + optional: true + + '@esbuild/sunos-x64@0.23.1': + optional: true + + '@esbuild/win32-arm64@0.23.1': + optional: true + + '@esbuild/win32-ia32@0.23.1': + optional: true + + '@esbuild/win32-x64@0.23.1': + optional: true + + '@eslint-community/eslint-utils@4.4.0(eslint@8.57.0)': + dependencies: + eslint: 8.57.0 + eslint-visitor-keys: 3.4.3 + + '@eslint-community/regexpp@4.11.0': {} + + '@eslint/eslintrc@2.1.4': + dependencies: + ajv: 6.12.6 + debug: 4.3.7(supports-color@8.1.1) + espree: 9.6.1 + globals: 13.24.0 + ignore: 5.3.2 + import-fresh: 3.3.0 + js-yaml: 4.1.0 + minimatch: 3.1.2 + strip-json-comments: 3.1.1 + transitivePeerDependencies: + - supports-color + + '@eslint/js@8.57.0': {} + + '@eth-optimism/contracts@0.5.40(ethers@6.13.2)': + dependencies: + '@eth-optimism/core-utils': 0.12.0 + '@ethersproject/abstract-provider': 5.7.0 + '@ethersproject/abstract-signer': 5.7.0 + ethers: 6.13.2 + transitivePeerDependencies: + - bufferutil + - utf-8-validate + + '@eth-optimism/core-utils@0.12.0': + dependencies: + '@ethersproject/abi': 5.7.0 + '@ethersproject/abstract-provider': 5.7.0 + '@ethersproject/address': 5.7.0 + '@ethersproject/bignumber': 5.7.0 + '@ethersproject/bytes': 5.7.0 + '@ethersproject/constants': 5.7.0 + '@ethersproject/contracts': 5.7.0 + '@ethersproject/hash': 5.7.0 + '@ethersproject/keccak256': 5.7.0 + '@ethersproject/properties': 5.7.0 + '@ethersproject/providers': 5.7.2 + '@ethersproject/rlp': 5.7.0 + '@ethersproject/transactions': 5.7.0 + '@ethersproject/web': 5.7.1 + bufio: 1.2.1 + chai: 4.5.0 + transitivePeerDependencies: + - bufferutil + - utf-8-validate + + '@ethereumjs/rlp@4.0.1': {} + + '@ethereumjs/util@8.1.0': + dependencies: + '@ethereumjs/rlp': 4.0.1 + ethereum-cryptography: 2.2.1 + micro-ftch: 0.3.1 + + '@ethersproject/abi@5.7.0': + dependencies: + '@ethersproject/address': 5.7.0 + '@ethersproject/bignumber': 5.7.0 + '@ethersproject/bytes': 5.7.0 + '@ethersproject/constants': 5.7.0 + '@ethersproject/hash': 5.7.0 + '@ethersproject/keccak256': 5.7.0 + '@ethersproject/logger': 5.7.0 + '@ethersproject/properties': 5.7.0 + '@ethersproject/strings': 5.7.0 + + '@ethersproject/abstract-provider@5.7.0': + dependencies: + '@ethersproject/bignumber': 5.7.0 + '@ethersproject/bytes': 5.7.0 + '@ethersproject/logger': 5.7.0 + '@ethersproject/networks': 5.7.1 + '@ethersproject/properties': 5.7.0 + '@ethersproject/transactions': 5.7.0 + '@ethersproject/web': 5.7.1 + + '@ethersproject/abstract-signer@5.7.0': + dependencies: + '@ethersproject/abstract-provider': 5.7.0 + '@ethersproject/bignumber': 5.7.0 + '@ethersproject/bytes': 5.7.0 + '@ethersproject/logger': 5.7.0 + '@ethersproject/properties': 5.7.0 + + '@ethersproject/address@5.6.1': + dependencies: + '@ethersproject/bignumber': 5.7.0 + '@ethersproject/bytes': 5.7.0 + '@ethersproject/keccak256': 5.7.0 + '@ethersproject/logger': 5.7.0 + '@ethersproject/rlp': 5.7.0 + + '@ethersproject/address@5.7.0': + dependencies: + '@ethersproject/bignumber': 5.7.0 + '@ethersproject/bytes': 5.7.0 + '@ethersproject/keccak256': 5.7.0 + '@ethersproject/logger': 5.7.0 + '@ethersproject/rlp': 5.7.0 + + '@ethersproject/base64@5.7.0': + dependencies: + '@ethersproject/bytes': 5.7.0 + + '@ethersproject/basex@5.7.0': + dependencies: + '@ethersproject/bytes': 5.7.0 + '@ethersproject/properties': 5.7.0 + + '@ethersproject/bignumber@5.7.0': + dependencies: + '@ethersproject/bytes': 5.7.0 + '@ethersproject/logger': 5.7.0 + bn.js: 5.2.1 + + '@ethersproject/bytes@5.7.0': + dependencies: + '@ethersproject/logger': 5.7.0 + + '@ethersproject/constants@5.7.0': + dependencies: + '@ethersproject/bignumber': 5.7.0 + + '@ethersproject/contracts@5.7.0': + dependencies: + '@ethersproject/abi': 5.7.0 + '@ethersproject/abstract-provider': 5.7.0 + '@ethersproject/abstract-signer': 5.7.0 + '@ethersproject/address': 5.7.0 + '@ethersproject/bignumber': 5.7.0 + '@ethersproject/bytes': 5.7.0 + '@ethersproject/constants': 5.7.0 + '@ethersproject/logger': 5.7.0 + '@ethersproject/properties': 5.7.0 + '@ethersproject/transactions': 5.7.0 + + '@ethersproject/hash@5.7.0': + dependencies: + '@ethersproject/abstract-signer': 5.7.0 + '@ethersproject/address': 5.7.0 + '@ethersproject/base64': 5.7.0 + '@ethersproject/bignumber': 5.7.0 + '@ethersproject/bytes': 5.7.0 + '@ethersproject/keccak256': 5.7.0 + '@ethersproject/logger': 5.7.0 + '@ethersproject/properties': 5.7.0 + '@ethersproject/strings': 5.7.0 + + '@ethersproject/hdnode@5.7.0': + dependencies: + '@ethersproject/abstract-signer': 5.7.0 + '@ethersproject/basex': 5.7.0 + '@ethersproject/bignumber': 5.7.0 + '@ethersproject/bytes': 5.7.0 + '@ethersproject/logger': 5.7.0 + '@ethersproject/pbkdf2': 5.7.0 + '@ethersproject/properties': 5.7.0 + '@ethersproject/sha2': 5.7.0 + '@ethersproject/signing-key': 5.7.0 + '@ethersproject/strings': 5.7.0 + '@ethersproject/transactions': 5.7.0 + '@ethersproject/wordlists': 5.7.0 + + '@ethersproject/json-wallets@5.7.0': + dependencies: + '@ethersproject/abstract-signer': 5.7.0 + '@ethersproject/address': 5.7.0 + '@ethersproject/bytes': 5.7.0 + '@ethersproject/hdnode': 5.7.0 + '@ethersproject/keccak256': 5.7.0 + '@ethersproject/logger': 5.7.0 + '@ethersproject/pbkdf2': 5.7.0 + '@ethersproject/properties': 5.7.0 + '@ethersproject/random': 5.7.0 + '@ethersproject/strings': 5.7.0 + '@ethersproject/transactions': 5.7.0 + aes-js: 3.0.0 + scrypt-js: 3.0.1 + + '@ethersproject/keccak256@5.7.0': + dependencies: + '@ethersproject/bytes': 5.7.0 + js-sha3: 0.8.0 + + '@ethersproject/logger@5.7.0': {} + + '@ethersproject/networks@5.7.1': + dependencies: + '@ethersproject/logger': 5.7.0 + + '@ethersproject/pbkdf2@5.7.0': + dependencies: + '@ethersproject/bytes': 5.7.0 + '@ethersproject/sha2': 5.7.0 + + '@ethersproject/properties@5.7.0': + dependencies: + '@ethersproject/logger': 5.7.0 + + '@ethersproject/providers@5.7.2': + dependencies: + '@ethersproject/abstract-provider': 5.7.0 + '@ethersproject/abstract-signer': 5.7.0 + '@ethersproject/address': 5.7.0 + '@ethersproject/base64': 5.7.0 + '@ethersproject/basex': 5.7.0 + '@ethersproject/bignumber': 5.7.0 + '@ethersproject/bytes': 5.7.0 + '@ethersproject/constants': 5.7.0 + '@ethersproject/hash': 5.7.0 + '@ethersproject/logger': 5.7.0 + '@ethersproject/networks': 5.7.1 + '@ethersproject/properties': 5.7.0 + '@ethersproject/random': 5.7.0 + '@ethersproject/rlp': 5.7.0 + '@ethersproject/sha2': 5.7.0 + '@ethersproject/strings': 5.7.0 + '@ethersproject/transactions': 5.7.0 + '@ethersproject/web': 5.7.1 + bech32: 1.1.4 + ws: 7.4.6 + transitivePeerDependencies: + - bufferutil + - utf-8-validate + + '@ethersproject/random@5.7.0': + dependencies: + '@ethersproject/bytes': 5.7.0 + '@ethersproject/logger': 5.7.0 + + '@ethersproject/rlp@5.7.0': + dependencies: + '@ethersproject/bytes': 5.7.0 + '@ethersproject/logger': 5.7.0 + + '@ethersproject/sha2@5.7.0': + dependencies: + '@ethersproject/bytes': 5.7.0 + '@ethersproject/logger': 5.7.0 + hash.js: 1.1.7 + + '@ethersproject/signing-key@5.7.0': + dependencies: + '@ethersproject/bytes': 5.7.0 + '@ethersproject/logger': 5.7.0 + '@ethersproject/properties': 5.7.0 + bn.js: 5.2.1 + elliptic: 6.5.4 + hash.js: 1.1.7 + + '@ethersproject/solidity@5.7.0': + dependencies: + '@ethersproject/bignumber': 5.7.0 + '@ethersproject/bytes': 5.7.0 + '@ethersproject/keccak256': 5.7.0 + '@ethersproject/logger': 5.7.0 + '@ethersproject/sha2': 5.7.0 + '@ethersproject/strings': 5.7.0 + + '@ethersproject/strings@5.7.0': + dependencies: + '@ethersproject/bytes': 5.7.0 + '@ethersproject/constants': 5.7.0 + '@ethersproject/logger': 5.7.0 + + '@ethersproject/transactions@5.7.0': + dependencies: + '@ethersproject/address': 5.7.0 + '@ethersproject/bignumber': 5.7.0 + '@ethersproject/bytes': 5.7.0 + '@ethersproject/constants': 5.7.0 + '@ethersproject/keccak256': 5.7.0 + '@ethersproject/logger': 5.7.0 + '@ethersproject/properties': 5.7.0 + '@ethersproject/rlp': 5.7.0 + '@ethersproject/signing-key': 5.7.0 + + '@ethersproject/units@5.7.0': + dependencies: + '@ethersproject/bignumber': 5.7.0 + '@ethersproject/constants': 5.7.0 + '@ethersproject/logger': 5.7.0 + + '@ethersproject/wallet@5.7.0': + dependencies: + '@ethersproject/abstract-provider': 5.7.0 + '@ethersproject/abstract-signer': 5.7.0 + '@ethersproject/address': 5.7.0 + '@ethersproject/bignumber': 5.7.0 + '@ethersproject/bytes': 5.7.0 + '@ethersproject/hash': 5.7.0 + '@ethersproject/hdnode': 5.7.0 + '@ethersproject/json-wallets': 5.7.0 + '@ethersproject/keccak256': 5.7.0 + '@ethersproject/logger': 5.7.0 + '@ethersproject/properties': 5.7.0 + '@ethersproject/random': 5.7.0 + '@ethersproject/signing-key': 5.7.0 + '@ethersproject/transactions': 5.7.0 + '@ethersproject/wordlists': 5.7.0 + + '@ethersproject/web@5.7.1': + dependencies: + '@ethersproject/base64': 5.7.0 + '@ethersproject/bytes': 5.7.0 + '@ethersproject/logger': 5.7.0 + '@ethersproject/properties': 5.7.0 + '@ethersproject/strings': 5.7.0 + + '@ethersproject/wordlists@5.7.0': + dependencies: + '@ethersproject/bytes': 5.7.0 + '@ethersproject/hash': 5.7.0 + '@ethersproject/logger': 5.7.0 + '@ethersproject/properties': 5.7.0 + '@ethersproject/strings': 5.7.0 + + '@fastify/busboy@2.1.1': {} + + '@fastify/deepmerge@1.3.0': {} + + '@humanwhocodes/config-array@0.11.14': + dependencies: + '@humanwhocodes/object-schema': 2.0.3 + debug: 4.3.7(supports-color@8.1.1) + minimatch: 3.1.2 + transitivePeerDependencies: + - supports-color + + '@humanwhocodes/module-importer@1.0.1': {} + + '@humanwhocodes/object-schema@2.0.3': {} + + '@isaacs/cliui@8.0.2': + dependencies: + string-width: 5.1.2 + string-width-cjs: string-width@4.2.3 + strip-ansi: 7.1.0 + strip-ansi-cjs: strip-ansi@6.0.1 + wrap-ansi: 8.1.0 + wrap-ansi-cjs: wrap-ansi@7.0.0 + + '@jridgewell/gen-mapping@0.3.5': + dependencies: + '@jridgewell/set-array': 1.2.1 + '@jridgewell/sourcemap-codec': 1.5.0 + '@jridgewell/trace-mapping': 0.3.25 + + '@jridgewell/resolve-uri@3.1.2': {} + + '@jridgewell/set-array@1.2.1': {} + + '@jridgewell/sourcemap-codec@1.5.0': {} + + '@jridgewell/trace-mapping@0.3.25': + dependencies: + '@jridgewell/resolve-uri': 3.1.2 + '@jridgewell/sourcemap-codec': 1.5.0 + + '@jridgewell/trace-mapping@0.3.9': + dependencies: + '@jridgewell/resolve-uri': 3.1.2 + '@jridgewell/sourcemap-codec': 1.5.0 + + '@looksrare/contracts-libs@3.5.1': {} + + '@metamask/eth-sig-util@4.0.1': + dependencies: + ethereumjs-abi: 0.6.8 + ethereumjs-util: 6.2.1 + ethjs-util: 0.1.6 + tweetnacl: 1.0.3 + tweetnacl-util: 0.15.1 + + '@noble/curves@1.2.0': + dependencies: + '@noble/hashes': 1.3.2 + + '@noble/curves@1.4.0': + dependencies: + '@noble/hashes': 1.4.0 + + '@noble/curves@1.4.2': + dependencies: + '@noble/hashes': 1.4.0 + + '@noble/hashes@1.2.0': {} + + '@noble/hashes@1.3.2': {} + + '@noble/hashes@1.4.0': {} + + '@noble/hashes@1.5.0': {} + + '@noble/secp256k1@1.7.1': {} + + '@nodelib/fs.scandir@2.1.5': + dependencies: + '@nodelib/fs.stat': 2.0.5 + run-parallel: 1.2.0 + + '@nodelib/fs.stat@2.0.5': {} + + '@nodelib/fs.walk@1.2.8': + dependencies: + '@nodelib/fs.scandir': 2.1.5 + fastq: 1.17.1 + + '@nomicfoundation/edr-darwin-arm64@0.5.2': {} + + '@nomicfoundation/edr-darwin-x64@0.5.2': {} + + '@nomicfoundation/edr-linux-arm64-gnu@0.5.2': {} + + '@nomicfoundation/edr-linux-arm64-musl@0.5.2': {} + + '@nomicfoundation/edr-linux-x64-gnu@0.5.2': {} + + '@nomicfoundation/edr-linux-x64-musl@0.5.2': {} + + '@nomicfoundation/edr-win32-x64-msvc@0.5.2': {} + + '@nomicfoundation/edr@0.5.2': + dependencies: + '@nomicfoundation/edr-darwin-arm64': 0.5.2 + '@nomicfoundation/edr-darwin-x64': 0.5.2 + '@nomicfoundation/edr-linux-arm64-gnu': 0.5.2 + '@nomicfoundation/edr-linux-arm64-musl': 0.5.2 + '@nomicfoundation/edr-linux-x64-gnu': 0.5.2 + '@nomicfoundation/edr-linux-x64-musl': 0.5.2 + '@nomicfoundation/edr-win32-x64-msvc': 0.5.2 + + '@nomicfoundation/ethereumjs-common@4.0.4': + dependencies: + '@nomicfoundation/ethereumjs-util': 9.0.4 + transitivePeerDependencies: + - c-kzg + + '@nomicfoundation/ethereumjs-rlp@5.0.4': {} + + '@nomicfoundation/ethereumjs-tx@5.0.4': + dependencies: + '@nomicfoundation/ethereumjs-common': 4.0.4 + '@nomicfoundation/ethereumjs-rlp': 5.0.4 + '@nomicfoundation/ethereumjs-util': 9.0.4 + ethereum-cryptography: 0.1.3 + + '@nomicfoundation/ethereumjs-util@9.0.4': + dependencies: + '@nomicfoundation/ethereumjs-rlp': 5.0.4 + ethereum-cryptography: 0.1.3 + + '@nomicfoundation/hardhat-chai-matchers@2.0.7(@nomicfoundation/hardhat-ethers@3.0.8(ethers@6.13.2)(hardhat@2.22.10(ts-node@10.9.2(@swc/core@1.7.26)(@types/node@18.19.50)(typescript@5.6.2))(typescript@5.6.2)))(chai@4.5.0)(ethers@6.13.2)(hardhat@2.22.10(ts-node@10.9.2(@swc/core@1.7.26)(@types/node@18.19.50)(typescript@5.6.2))(typescript@5.6.2))': + dependencies: + '@nomicfoundation/hardhat-ethers': 3.0.8(ethers@6.13.2)(hardhat@2.22.10(ts-node@10.9.2(@swc/core@1.7.26)(@types/node@18.19.50)(typescript@5.6.2))(typescript@5.6.2)) + '@types/chai-as-promised': 7.1.8 + chai: 4.5.0 + chai-as-promised: 7.1.2(chai@4.5.0) + deep-eql: 4.1.4 + ethers: 6.13.2 + hardhat: 2.22.10(ts-node@10.9.2(@swc/core@1.7.26)(@types/node@18.19.50)(typescript@5.6.2))(typescript@5.6.2) + ordinal: 1.0.3 + + '@nomicfoundation/hardhat-ethers@3.0.8(ethers@6.13.2)(hardhat@2.22.10(ts-node@10.9.2(@swc/core@1.7.26)(@types/node@18.19.50)(typescript@5.6.2))(typescript@5.6.2))': + dependencies: + debug: 4.3.7(supports-color@8.1.1) + ethers: 6.13.2 + hardhat: 2.22.10(ts-node@10.9.2(@swc/core@1.7.26)(@types/node@18.19.50)(typescript@5.6.2))(typescript@5.6.2) + lodash.isequal: 4.5.0 + transitivePeerDependencies: + - supports-color + + '@nomicfoundation/hardhat-ignition-ethers@0.15.5(@nomicfoundation/hardhat-ethers@3.0.8(ethers@6.13.2)(hardhat@2.22.10(ts-node@10.9.2(@swc/core@1.7.26)(@types/node@18.19.50)(typescript@5.6.2))(typescript@5.6.2)))(@nomicfoundation/hardhat-ignition@0.15.5(@nomicfoundation/hardhat-verify@2.0.10(hardhat@2.22.10(ts-node@10.9.2(@swc/core@1.7.26)(@types/node@18.19.50)(typescript@5.6.2))(typescript@5.6.2)))(hardhat@2.22.10(ts-node@10.9.2(@swc/core@1.7.26)(@types/node@18.19.50)(typescript@5.6.2))(typescript@5.6.2)))(@nomicfoundation/ignition-core@0.15.5)(ethers@6.13.2)(hardhat@2.22.10(ts-node@10.9.2(@swc/core@1.7.26)(@types/node@18.19.50)(typescript@5.6.2))(typescript@5.6.2))': + dependencies: + '@nomicfoundation/hardhat-ethers': 3.0.8(ethers@6.13.2)(hardhat@2.22.10(ts-node@10.9.2(@swc/core@1.7.26)(@types/node@18.19.50)(typescript@5.6.2))(typescript@5.6.2)) + '@nomicfoundation/hardhat-ignition': 0.15.5(@nomicfoundation/hardhat-verify@2.0.10(hardhat@2.22.10(ts-node@10.9.2(@swc/core@1.7.26)(@types/node@18.19.50)(typescript@5.6.2))(typescript@5.6.2)))(hardhat@2.22.10(ts-node@10.9.2(@swc/core@1.7.26)(@types/node@18.19.50)(typescript@5.6.2))(typescript@5.6.2)) + '@nomicfoundation/ignition-core': 0.15.5 + ethers: 6.13.2 + hardhat: 2.22.10(ts-node@10.9.2(@swc/core@1.7.26)(@types/node@18.19.50)(typescript@5.6.2))(typescript@5.6.2) + + '@nomicfoundation/hardhat-ignition@0.15.5(@nomicfoundation/hardhat-verify@2.0.10(hardhat@2.22.10(ts-node@10.9.2(@swc/core@1.7.26)(@types/node@18.19.50)(typescript@5.6.2))(typescript@5.6.2)))(hardhat@2.22.10(ts-node@10.9.2(@swc/core@1.7.26)(@types/node@18.19.50)(typescript@5.6.2))(typescript@5.6.2))': + dependencies: + '@nomicfoundation/hardhat-verify': 2.0.10(hardhat@2.22.10(ts-node@10.9.2(@swc/core@1.7.26)(@types/node@18.19.50)(typescript@5.6.2))(typescript@5.6.2)) + '@nomicfoundation/ignition-core': 0.15.5 + '@nomicfoundation/ignition-ui': 0.15.5 + chalk: 4.1.2 + debug: 4.3.7(supports-color@8.1.1) + fs-extra: 10.1.0 + hardhat: 2.22.10(ts-node@10.9.2(@swc/core@1.7.26)(@types/node@18.19.50)(typescript@5.6.2))(typescript@5.6.2) + prompts: 2.4.2 + transitivePeerDependencies: + - bufferutil + - supports-color + - utf-8-validate + + '@nomicfoundation/hardhat-network-helpers@1.0.11(hardhat@2.22.10(ts-node@10.9.2(@swc/core@1.7.26)(@types/node@18.19.50)(typescript@5.6.2))(typescript@5.6.2))': + dependencies: + ethereumjs-util: 7.1.5 + hardhat: 2.22.10(ts-node@10.9.2(@swc/core@1.7.26)(@types/node@18.19.50)(typescript@5.6.2))(typescript@5.6.2) + + ? '@nomicfoundation/hardhat-toolbox@5.0.0(@nomicfoundation/hardhat-chai-matchers@2.0.7(@nomicfoundation/hardhat-ethers@3.0.8(ethers@6.13.2)(hardhat@2.22.10(ts-node@10.9.2(@swc/core@1.7.26)(@types/node@18.19.50)(typescript@5.6.2))(typescript@5.6.2)))(chai@4.5.0)(ethers@6.13.2)(hardhat@2.22.10(ts-node@10.9.2(@swc/core@1.7.26)(@types/node@18.19.50)(typescript@5.6.2))(typescript@5.6.2)))(@nomicfoundation/hardhat-ethers@3.0.8(ethers@6.13.2)(hardhat@2.22.10(ts-node@10.9.2(@swc/core@1.7.26)(@types/node@18.19.50)(typescript@5.6.2))(typescript@5.6.2)))(@nomicfoundation/hardhat-ignition-ethers@0.15.5(@nomicfoundation/hardhat-ethers@3.0.8(ethers@6.13.2)(hardhat@2.22.10(ts-node@10.9.2(@swc/core@1.7.26)(@types/node@18.19.50)(typescript@5.6.2))(typescript@5.6.2)))(@nomicfoundation/hardhat-ignition@0.15.5(@nomicfoundation/hardhat-verify@2.0.10(hardhat@2.22.10(ts-node@10.9.2(@swc/core@1.7.26)(@types/node@18.19.50)(typescript@5.6.2))(typescript@5.6.2)))(hardhat@2.22.10(ts-node@10.9.2(@swc/core@1.7.26)(@types/node@18.19.50)(typescript@5.6.2))(typescript@5.6.2)))(@nomicfoundation/ignition-core@0.15.5)(ethers@6.13.2)(hardhat@2.22.10(ts-node@10.9.2(@swc/core@1.7.26)(@types/node@18.19.50)(typescript@5.6.2))(typescript@5.6.2)))(@nomicfoundation/hardhat-network-helpers@1.0.11(hardhat@2.22.10(ts-node@10.9.2(@swc/core@1.7.26)(@types/node@18.19.50)(typescript@5.6.2))(typescript@5.6.2)))(@nomicfoundation/hardhat-verify@2.0.10(hardhat@2.22.10(ts-node@10.9.2(@swc/core@1.7.26)(@types/node@18.19.50)(typescript@5.6.2))(typescript@5.6.2)))(@typechain/ethers-v6@0.5.1(ethers@6.13.2)(typechain@8.3.2(typescript@5.6.2))(typescript@5.6.2))(@typechain/hardhat@9.1.0(@typechain/ethers-v6@0.5.1(ethers@6.13.2)(typechain@8.3.2(typescript@5.6.2))(typescript@5.6.2))(ethers@6.13.2)(hardhat@2.22.10(ts-node@10.9.2(@swc/core@1.7.26)(@types/node@18.19.50)(typescript@5.6.2))(typescript@5.6.2))(typechain@8.3.2(typescript@5.6.2)))(@types/chai@4.3.19)(@types/mocha@10.0.7)(@types/node@18.19.50)(chai@4.5.0)(ethers@6.13.2)(hardhat-gas-reporter@1.0.10(hardhat@2.22.10(ts-node@10.9.2(@swc/core@1.7.26)(@types/node@18.19.50)(typescript@5.6.2))(typescript@5.6.2)))(hardhat@2.22.10(ts-node@10.9.2(@swc/core@1.7.26)(@types/node@18.19.50)(typescript@5.6.2))(typescript@5.6.2))(solidity-coverage@0.8.13(hardhat@2.22.10(ts-node@10.9.2(@swc/core@1.7.26)(@types/node@18.19.50)(typescript@5.6.2))(typescript@5.6.2)))(ts-node@10.9.2(@swc/core@1.7.26)(@types/node@18.19.50)(typescript@5.6.2))(typechain@8.3.2(typescript@5.6.2))(typescript@5.6.2)' + : dependencies: + '@nomicfoundation/hardhat-chai-matchers': 2.0.7(@nomicfoundation/hardhat-ethers@3.0.8(ethers@6.13.2)(hardhat@2.22.10(ts-node@10.9.2(@swc/core@1.7.26)(@types/node@18.19.50)(typescript@5.6.2))(typescript@5.6.2)))(chai@4.5.0)(ethers@6.13.2)(hardhat@2.22.10(ts-node@10.9.2(@swc/core@1.7.26)(@types/node@18.19.50)(typescript@5.6.2))(typescript@5.6.2)) + '@nomicfoundation/hardhat-ethers': 3.0.8(ethers@6.13.2)(hardhat@2.22.10(ts-node@10.9.2(@swc/core@1.7.26)(@types/node@18.19.50)(typescript@5.6.2))(typescript@5.6.2)) + '@nomicfoundation/hardhat-ignition-ethers': 0.15.5(@nomicfoundation/hardhat-ethers@3.0.8(ethers@6.13.2)(hardhat@2.22.10(ts-node@10.9.2(@swc/core@1.7.26)(@types/node@18.19.50)(typescript@5.6.2))(typescript@5.6.2)))(@nomicfoundation/hardhat-ignition@0.15.5(@nomicfoundation/hardhat-verify@2.0.10(hardhat@2.22.10(ts-node@10.9.2(@swc/core@1.7.26)(@types/node@18.19.50)(typescript@5.6.2))(typescript@5.6.2)))(hardhat@2.22.10(ts-node@10.9.2(@swc/core@1.7.26)(@types/node@18.19.50)(typescript@5.6.2))(typescript@5.6.2)))(@nomicfoundation/ignition-core@0.15.5)(ethers@6.13.2)(hardhat@2.22.10(ts-node@10.9.2(@swc/core@1.7.26)(@types/node@18.19.50)(typescript@5.6.2))(typescript@5.6.2)) + '@nomicfoundation/hardhat-network-helpers': 1.0.11(hardhat@2.22.10(ts-node@10.9.2(@swc/core@1.7.26)(@types/node@18.19.50)(typescript@5.6.2))(typescript@5.6.2)) + '@nomicfoundation/hardhat-verify': 2.0.10(hardhat@2.22.10(ts-node@10.9.2(@swc/core@1.7.26)(@types/node@18.19.50)(typescript@5.6.2))(typescript@5.6.2)) + '@typechain/ethers-v6': 0.5.1(ethers@6.13.2)(typechain@8.3.2(typescript@5.6.2))(typescript@5.6.2) + '@typechain/hardhat': 9.1.0(@typechain/ethers-v6@0.5.1(ethers@6.13.2)(typechain@8.3.2(typescript@5.6.2))(typescript@5.6.2))(ethers@6.13.2)(hardhat@2.22.10(ts-node@10.9.2(@swc/core@1.7.26)(@types/node@18.19.50)(typescript@5.6.2))(typescript@5.6.2))(typechain@8.3.2(typescript@5.6.2)) + '@types/chai': 4.3.19 + '@types/mocha': 10.0.7 + '@types/node': 18.19.50 + chai: 4.5.0 + ethers: 6.13.2 + hardhat: 2.22.10(ts-node@10.9.2(@swc/core@1.7.26)(@types/node@18.19.50)(typescript@5.6.2))(typescript@5.6.2) + hardhat-gas-reporter: 1.0.10(hardhat@2.22.10(ts-node@10.9.2(@swc/core@1.7.26)(@types/node@18.19.50)(typescript@5.6.2))(typescript@5.6.2)) + solidity-coverage: 0.8.13(hardhat@2.22.10(ts-node@10.9.2(@swc/core@1.7.26)(@types/node@18.19.50)(typescript@5.6.2))(typescript@5.6.2)) + ts-node: 10.9.2(@swc/core@1.7.26)(@types/node@18.19.50)(typescript@5.6.2) + typechain: 8.3.2(typescript@5.6.2) + typescript: 5.6.2 + + '@nomicfoundation/hardhat-verify@2.0.10(hardhat@2.22.10(ts-node@10.9.2(@swc/core@1.7.26)(@types/node@18.19.50)(typescript@5.6.2))(typescript@5.6.2))': + dependencies: + '@ethersproject/abi': 5.7.0 + '@ethersproject/address': 5.7.0 + cbor: 8.1.0 + chalk: 2.4.2 + debug: 4.3.7(supports-color@8.1.1) + hardhat: 2.22.10(ts-node@10.9.2(@swc/core@1.7.26)(@types/node@18.19.50)(typescript@5.6.2))(typescript@5.6.2) + lodash.clonedeep: 4.5.0 + semver: 6.3.1 + table: 6.8.2 + undici: 5.28.4 + transitivePeerDependencies: + - supports-color + + '@nomicfoundation/hardhat-viem@2.0.4(hardhat@2.22.10(ts-node@10.9.2(@swc/core@1.7.26)(@types/node@18.19.50)(typescript@5.6.2))(typescript@5.6.2))(typescript@5.6.2)(viem@2.21.5(typescript@5.6.2))': + dependencies: + abitype: 0.9.10(typescript@5.6.2) + hardhat: 2.22.10(ts-node@10.9.2(@swc/core@1.7.26)(@types/node@18.19.50)(typescript@5.6.2))(typescript@5.6.2) + lodash.memoize: 4.1.2 + typescript: 5.6.2 + viem: 2.21.5(typescript@5.6.2) + transitivePeerDependencies: + - zod + + '@nomicfoundation/ignition-core@0.15.5': + dependencies: + '@ethersproject/address': 5.6.1 + '@nomicfoundation/solidity-analyzer': 0.1.2 + cbor: 9.0.2 + debug: 4.3.7(supports-color@8.1.1) + ethers: 6.13.2 + fs-extra: 10.1.0 + immer: 10.0.2 + lodash: 4.17.21 + ndjson: 2.0.0 + transitivePeerDependencies: + - bufferutil + - supports-color + - utf-8-validate + + '@nomicfoundation/ignition-ui@0.15.5': {} + + '@nomicfoundation/slang-darwin-arm64@0.17.0': {} + + '@nomicfoundation/slang-darwin-x64@0.17.0': {} + + '@nomicfoundation/slang-linux-arm64-gnu@0.17.0': {} + + '@nomicfoundation/slang-linux-arm64-musl@0.17.0': {} + + '@nomicfoundation/slang-linux-x64-gnu@0.17.0': {} + + '@nomicfoundation/slang-linux-x64-musl@0.17.0': {} + + '@nomicfoundation/slang-win32-arm64-msvc@0.17.0': {} + + '@nomicfoundation/slang-win32-ia32-msvc@0.17.0': {} + + '@nomicfoundation/slang-win32-x64-msvc@0.17.0': {} + + '@nomicfoundation/slang@0.17.0': + dependencies: + '@nomicfoundation/slang-darwin-arm64': 0.17.0 + '@nomicfoundation/slang-darwin-x64': 0.17.0 + '@nomicfoundation/slang-linux-arm64-gnu': 0.17.0 + '@nomicfoundation/slang-linux-arm64-musl': 0.17.0 + '@nomicfoundation/slang-linux-x64-gnu': 0.17.0 + '@nomicfoundation/slang-linux-x64-musl': 0.17.0 + '@nomicfoundation/slang-win32-arm64-msvc': 0.17.0 + '@nomicfoundation/slang-win32-ia32-msvc': 0.17.0 + '@nomicfoundation/slang-win32-x64-msvc': 0.17.0 + + '@nomicfoundation/solidity-analyzer-darwin-arm64@0.1.2': + optional: true + + '@nomicfoundation/solidity-analyzer-darwin-x64@0.1.2': + optional: true + + '@nomicfoundation/solidity-analyzer-linux-arm64-gnu@0.1.2': + optional: true + + '@nomicfoundation/solidity-analyzer-linux-arm64-musl@0.1.2': + optional: true + + '@nomicfoundation/solidity-analyzer-linux-x64-gnu@0.1.2': + optional: true + + '@nomicfoundation/solidity-analyzer-linux-x64-musl@0.1.2': + optional: true + + '@nomicfoundation/solidity-analyzer-win32-x64-msvc@0.1.2': + optional: true + + '@nomicfoundation/solidity-analyzer@0.1.2': + optionalDependencies: + '@nomicfoundation/solidity-analyzer-darwin-arm64': 0.1.2 + '@nomicfoundation/solidity-analyzer-darwin-x64': 0.1.2 + '@nomicfoundation/solidity-analyzer-linux-arm64-gnu': 0.1.2 + '@nomicfoundation/solidity-analyzer-linux-arm64-musl': 0.1.2 + '@nomicfoundation/solidity-analyzer-linux-x64-gnu': 0.1.2 + '@nomicfoundation/solidity-analyzer-linux-x64-musl': 0.1.2 + '@nomicfoundation/solidity-analyzer-win32-x64-msvc': 0.1.2 + + '@openzeppelin/contracts-upgradeable@4.7.3': {} + + '@openzeppelin/contracts@3.4.2': {} + + '@openzeppelin/contracts@4.3.3': {} + + '@openzeppelin/contracts@4.9.6': {} + + '@openzeppelin/defender-sdk-base-client@1.14.4': + dependencies: + amazon-cognito-identity-js: 6.3.12 + async-retry: 1.3.3 + transitivePeerDependencies: + - encoding + + '@openzeppelin/defender-sdk-deploy-client@1.14.4(debug@4.3.7)': + dependencies: + '@openzeppelin/defender-sdk-base-client': 1.14.4 + axios: 1.7.7(debug@4.3.7) + lodash: 4.17.21 + transitivePeerDependencies: + - debug + - encoding + + '@openzeppelin/defender-sdk-network-client@1.14.4(debug@4.3.7)': + dependencies: + '@openzeppelin/defender-sdk-base-client': 1.14.4 + axios: 1.7.7(debug@4.3.7) + lodash: 4.17.21 + transitivePeerDependencies: + - debug + - encoding + + '@openzeppelin/hardhat-upgrades@3.2.1(@nomicfoundation/hardhat-ethers@3.0.8(ethers@6.13.2)(hardhat@2.22.10(ts-node@10.9.2(@swc/core@1.7.26)(@types/node@18.19.50)(typescript@5.6.2))(typescript@5.6.2)))(@nomicfoundation/hardhat-verify@2.0.10(hardhat@2.22.10(ts-node@10.9.2(@swc/core@1.7.26)(@types/node@18.19.50)(typescript@5.6.2))(typescript@5.6.2)))(ethers@6.13.2)(hardhat@2.22.10(ts-node@10.9.2(@swc/core@1.7.26)(@types/node@18.19.50)(typescript@5.6.2))(typescript@5.6.2))': + dependencies: + '@nomicfoundation/hardhat-ethers': 3.0.8(ethers@6.13.2)(hardhat@2.22.10(ts-node@10.9.2(@swc/core@1.7.26)(@types/node@18.19.50)(typescript@5.6.2))(typescript@5.6.2)) + '@openzeppelin/defender-sdk-base-client': 1.14.4 + '@openzeppelin/defender-sdk-deploy-client': 1.14.4(debug@4.3.7) + '@openzeppelin/defender-sdk-network-client': 1.14.4(debug@4.3.7) + '@openzeppelin/upgrades-core': 1.37.1 + chalk: 4.1.2 + debug: 4.3.7(supports-color@8.1.1) + ethereumjs-util: 7.1.5 + ethers: 6.13.2 + hardhat: 2.22.10(ts-node@10.9.2(@swc/core@1.7.26)(@types/node@18.19.50)(typescript@5.6.2))(typescript@5.6.2) + proper-lockfile: 4.1.2 + undici: 6.19.8 + optionalDependencies: + '@nomicfoundation/hardhat-verify': 2.0.10(hardhat@2.22.10(ts-node@10.9.2(@swc/core@1.7.26)(@types/node@18.19.50)(typescript@5.6.2))(typescript@5.6.2)) + transitivePeerDependencies: + - encoding + - supports-color + + '@openzeppelin/upgrades-core@1.37.1': + dependencies: + '@nomicfoundation/slang': 0.17.0 + cbor: 9.0.2 + chalk: 4.1.2 + compare-versions: 6.1.1 + debug: 4.3.7(supports-color@8.1.1) + ethereumjs-util: 7.1.5 + minimatch: 9.0.5 + minimist: 1.2.8 + proper-lockfile: 4.1.2 + solidity-ast: 0.4.59 + transitivePeerDependencies: + - supports-color + + '@pkgjs/parseargs@0.11.0': + optional: true + + '@primitivefi/hardhat-dodoc@0.2.3(hardhat@2.22.10(ts-node@10.9.2(@swc/core@1.7.26)(@types/node@18.19.50)(typescript@5.6.2))(typescript@5.6.2))(squirrelly@8.0.8)': + dependencies: + hardhat: 2.22.10(ts-node@10.9.2(@swc/core@1.7.26)(@types/node@18.19.50)(typescript@5.6.2))(typescript@5.6.2) + squirrelly: 8.0.8 + + '@rollup/plugin-commonjs@24.1.0(rollup@4.21.2)': + dependencies: + '@rollup/pluginutils': 5.1.0(rollup@4.21.2) + commondir: 1.0.1 + estree-walker: 2.0.2 + glob: 8.1.0 + is-reference: 1.2.1 + magic-string: 0.27.0 + optionalDependencies: + rollup: 4.21.2 + + '@rollup/plugin-json@6.1.0(rollup@4.21.2)': + dependencies: + '@rollup/pluginutils': 5.1.0(rollup@4.21.2) + optionalDependencies: + rollup: 4.21.2 + + '@rollup/plugin-node-resolve@15.2.3(rollup@4.21.2)': + dependencies: + '@rollup/pluginutils': 5.1.0(rollup@4.21.2) + '@types/resolve': 1.20.2 + deepmerge: 4.3.1 + is-builtin-module: 3.2.1 + is-module: 1.0.0 + resolve: 1.22.8 + optionalDependencies: + rollup: 4.21.2 + + '@rollup/pluginutils@5.1.0(rollup@4.21.2)': + dependencies: + '@types/estree': 1.0.5 + estree-walker: 2.0.2 + picomatch: 2.3.1 + optionalDependencies: + rollup: 4.21.2 + + '@rollup/rollup-android-arm-eabi@4.21.2': + optional: true + + '@rollup/rollup-android-arm64@4.21.2': + optional: true + + '@rollup/rollup-darwin-arm64@4.21.2': + optional: true + + '@rollup/rollup-darwin-x64@4.21.2': + optional: true + + '@rollup/rollup-linux-arm-gnueabihf@4.21.2': + optional: true + + '@rollup/rollup-linux-arm-musleabihf@4.21.2': + optional: true + + '@rollup/rollup-linux-arm64-gnu@4.21.2': + optional: true + + '@rollup/rollup-linux-arm64-musl@4.21.2': + optional: true + + '@rollup/rollup-linux-powerpc64le-gnu@4.21.2': + optional: true + + '@rollup/rollup-linux-riscv64-gnu@4.21.2': + optional: true + + '@rollup/rollup-linux-s390x-gnu@4.21.2': + optional: true + + '@rollup/rollup-linux-x64-gnu@4.21.2': + optional: true + + '@rollup/rollup-linux-x64-musl@4.21.2': + optional: true + + '@rollup/rollup-win32-arm64-msvc@4.21.2': + optional: true + + '@rollup/rollup-win32-ia32-msvc@4.21.2': + optional: true + + '@rollup/rollup-win32-x64-msvc@4.21.2': + optional: true + + '@scure/base@1.1.8': {} + + '@scure/bip32@1.1.5': + dependencies: + '@noble/hashes': 1.2.0 + '@noble/secp256k1': 1.7.1 + '@scure/base': 1.1.8 + + '@scure/bip32@1.4.0': + dependencies: + '@noble/curves': 1.4.0 + '@noble/hashes': 1.4.0 + '@scure/base': 1.1.8 + + '@scure/bip39@1.1.1': + dependencies: + '@noble/hashes': 1.2.0 + '@scure/base': 1.1.8 + + '@scure/bip39@1.3.0': + dependencies: + '@noble/hashes': 1.4.0 + '@scure/base': 1.1.8 + + '@scure/bip39@1.4.0': + dependencies: + '@noble/hashes': 1.5.0 + '@scure/base': 1.1.8 + + '@sentry/core@5.30.0': + dependencies: + '@sentry/hub': 5.30.0 + '@sentry/minimal': 5.30.0 + '@sentry/types': 5.30.0 + '@sentry/utils': 5.30.0 + tslib: 1.14.1 + + '@sentry/hub@5.30.0': + dependencies: + '@sentry/types': 5.30.0 + '@sentry/utils': 5.30.0 + tslib: 1.14.1 + + '@sentry/minimal@5.30.0': + dependencies: + '@sentry/hub': 5.30.0 + '@sentry/types': 5.30.0 + tslib: 1.14.1 + + '@sentry/node@5.30.0': + dependencies: + '@sentry/core': 5.30.0 + '@sentry/hub': 5.30.0 + '@sentry/tracing': 5.30.0 + '@sentry/types': 5.30.0 + '@sentry/utils': 5.30.0 + cookie: 0.4.2 + https-proxy-agent: 5.0.1 + lru_map: 0.3.3 + tslib: 1.14.1 + transitivePeerDependencies: + - supports-color + + '@sentry/tracing@5.30.0': + dependencies: + '@sentry/hub': 5.30.0 + '@sentry/minimal': 5.30.0 + '@sentry/types': 5.30.0 + '@sentry/utils': 5.30.0 + tslib: 1.14.1 + + '@sentry/types@5.30.0': {} + + '@sentry/utils@5.30.0': + dependencies: + '@sentry/types': 5.30.0 + tslib: 1.14.1 + + '@smithy/types@3.4.0': + dependencies: + tslib: 2.7.0 + + '@solidity-parser/parser@0.14.5': + dependencies: + antlr4ts: 0.5.0-alpha.4 + + '@solidity-parser/parser@0.16.2': + dependencies: + antlr4ts: 0.5.0-alpha.4 + + '@solidity-parser/parser@0.18.0': {} + + '@swc/core-darwin-arm64@1.7.26': + optional: true + + '@swc/core-darwin-x64@1.7.26': + optional: true + + '@swc/core-linux-arm-gnueabihf@1.7.26': + optional: true + + '@swc/core-linux-arm64-gnu@1.7.26': + optional: true + + '@swc/core-linux-arm64-musl@1.7.26': + optional: true + + '@swc/core-linux-x64-gnu@1.7.26': + optional: true + + '@swc/core-linux-x64-musl@1.7.26': + optional: true + + '@swc/core-win32-arm64-msvc@1.7.26': + optional: true + + '@swc/core-win32-ia32-msvc@1.7.26': + optional: true + + '@swc/core-win32-x64-msvc@1.7.26': + optional: true + + '@swc/core@1.7.26': + dependencies: + '@swc/counter': 0.1.3 + '@swc/types': 0.1.12 + optionalDependencies: + '@swc/core-darwin-arm64': 1.7.26 + '@swc/core-darwin-x64': 1.7.26 + '@swc/core-linux-arm-gnueabihf': 1.7.26 + '@swc/core-linux-arm64-gnu': 1.7.26 + '@swc/core-linux-arm64-musl': 1.7.26 + '@swc/core-linux-x64-gnu': 1.7.26 + '@swc/core-linux-x64-musl': 1.7.26 + '@swc/core-win32-arm64-msvc': 1.7.26 + '@swc/core-win32-ia32-msvc': 1.7.26 + '@swc/core-win32-x64-msvc': 1.7.26 + + '@swc/counter@0.1.3': {} + + '@swc/types@0.1.12': + dependencies: + '@swc/counter': 0.1.3 + + '@tenderly/hardhat-tenderly@2.3.0(@nomicfoundation/hardhat-ethers@3.0.8(ethers@6.13.2)(hardhat@2.22.10(ts-node@10.9.2(@swc/core@1.7.26)(@types/node@18.19.50)(typescript@5.6.2))(typescript@5.6.2)))(@swc/core@1.7.26)(@types/node@18.19.50)(ethers@6.13.2)(hardhat@2.22.10(ts-node@10.9.2(@swc/core@1.7.26)(@types/node@18.19.50)(typescript@5.6.2))(typescript@5.6.2))': + dependencies: + '@ethersproject/bignumber': 5.7.0 + '@nomicfoundation/hardhat-ignition': 0.15.5(@nomicfoundation/hardhat-verify@2.0.10(hardhat@2.22.10(ts-node@10.9.2(@swc/core@1.7.26)(@types/node@18.19.50)(typescript@5.6.2))(typescript@5.6.2)))(hardhat@2.22.10(ts-node@10.9.2(@swc/core@1.7.26)(@types/node@18.19.50)(typescript@5.6.2))(typescript@5.6.2)) + '@nomicfoundation/hardhat-verify': 2.0.10(hardhat@2.22.10(ts-node@10.9.2(@swc/core@1.7.26)(@types/node@18.19.50)(typescript@5.6.2))(typescript@5.6.2)) + '@openzeppelin/hardhat-upgrades': 3.2.1(@nomicfoundation/hardhat-ethers@3.0.8(ethers@6.13.2)(hardhat@2.22.10(ts-node@10.9.2(@swc/core@1.7.26)(@types/node@18.19.50)(typescript@5.6.2))(typescript@5.6.2)))(@nomicfoundation/hardhat-verify@2.0.10(hardhat@2.22.10(ts-node@10.9.2(@swc/core@1.7.26)(@types/node@18.19.50)(typescript@5.6.2))(typescript@5.6.2)))(ethers@6.13.2)(hardhat@2.22.10(ts-node@10.9.2(@swc/core@1.7.26)(@types/node@18.19.50)(typescript@5.6.2))(typescript@5.6.2)) + '@openzeppelin/upgrades-core': 1.37.1 + axios: 1.7.7(debug@4.3.7) + ethers: 6.13.2 + fs-extra: 10.1.0 + hardhat: 2.22.10(ts-node@10.9.2(@swc/core@1.7.26)(@types/node@18.19.50)(typescript@5.6.2))(typescript@5.6.2) + hardhat-deploy: 0.11.45 + tenderly: 0.9.1(ts-node@10.9.2(@swc/core@1.7.26)(@types/node@18.19.50)(typescript@5.6.2))(typescript@5.6.2) + ts-node: 10.9.2(@swc/core@1.7.26)(@types/node@18.19.50)(typescript@5.6.2) + tslog: 4.9.3 + typescript: 5.6.2 + transitivePeerDependencies: + - '@nomicfoundation/hardhat-ethers' + - '@swc/core' + - '@swc/wasm' + - '@types/node' + - bufferutil + - debug + - encoding + - supports-color + - utf-8-validate + + '@trivago/prettier-plugin-sort-imports@3.4.0(prettier@2.8.8)': + dependencies: + '@babel/core': 7.17.8 + '@babel/generator': 7.17.7 + '@babel/parser': 7.18.9 + '@babel/traverse': 7.17.3 + '@babel/types': 7.17.0 + '@vue/compiler-sfc': 3.5.4 + javascript-natural-sort: 0.7.1 + lodash: 4.17.21 + prettier: 2.8.8 + transitivePeerDependencies: + - supports-color + + '@tsconfig/node10@1.0.11': {} + + '@tsconfig/node12@1.0.11': {} + + '@tsconfig/node14@1.0.3': {} + + '@tsconfig/node16@1.0.4': {} + + '@typechain/ethers-v6@0.5.1(ethers@6.13.2)(typechain@8.3.2(typescript@5.6.2))(typescript@5.6.2)': + dependencies: + ethers: 6.13.2 + lodash: 4.17.21 + ts-essentials: 7.0.3(typescript@5.6.2) + typechain: 8.3.2(typescript@5.6.2) + typescript: 5.6.2 + + '@typechain/hardhat@9.1.0(@typechain/ethers-v6@0.5.1(ethers@6.13.2)(typechain@8.3.2(typescript@5.6.2))(typescript@5.6.2))(ethers@6.13.2)(hardhat@2.22.10(ts-node@10.9.2(@swc/core@1.7.26)(@types/node@18.19.50)(typescript@5.6.2))(typescript@5.6.2))(typechain@8.3.2(typescript@5.6.2))': + dependencies: + '@typechain/ethers-v6': 0.5.1(ethers@6.13.2)(typechain@8.3.2(typescript@5.6.2))(typescript@5.6.2) + ethers: 6.13.2 + fs-extra: 9.1.0 + hardhat: 2.22.10(ts-node@10.9.2(@swc/core@1.7.26)(@types/node@18.19.50)(typescript@5.6.2))(typescript@5.6.2) + typechain: 8.3.2(typescript@5.6.2) + + '@types/bn.js@4.11.6': + dependencies: + '@types/node': 18.19.50 + + '@types/bn.js@5.1.5': + dependencies: + '@types/node': 18.19.50 + + '@types/chai-as-promised@7.1.8': + dependencies: + '@types/chai': 4.3.19 + + '@types/chai@4.3.19': {} + + '@types/concat-stream@1.6.1': + dependencies: + '@types/node': 18.19.50 + + '@types/conventional-commits-parser@5.0.0': + dependencies: + '@types/node': 18.19.50 + optional: true + + '@types/estree@1.0.5': {} + + '@types/form-data@0.0.33': + dependencies: + '@types/node': 18.19.50 + + '@types/glob@7.2.0': + dependencies: + '@types/minimatch': 5.1.2 + '@types/node': 18.19.50 + + '@types/lru-cache@5.1.1': {} + + '@types/minimatch@5.1.2': {} + + '@types/minimist@1.2.5': {} + + '@types/mocha@10.0.7': {} + + '@types/node@10.17.60': {} + + '@types/node@18.15.13': {} + + '@types/node@18.19.50': + dependencies: + undici-types: 5.26.5 + + '@types/node@20.5.1': {} + + '@types/node@8.10.66': {} + + '@types/normalize-package-data@2.4.4': {} + + '@types/pbkdf2@3.1.2': + dependencies: + '@types/node': 18.19.50 + + '@types/prettier@2.7.3': {} + + '@types/qs@6.9.15': {} + + '@types/resolve@1.20.2': {} + + '@types/secp256k1@4.0.6': + dependencies: + '@types/node': 18.19.50 + + '@typescript-eslint/eslint-plugin@7.18.0(@typescript-eslint/parser@7.18.0(eslint@8.57.0)(typescript@5.6.2))(eslint@8.57.0)(typescript@5.6.2)': + dependencies: + '@eslint-community/regexpp': 4.11.0 + '@typescript-eslint/parser': 7.18.0(eslint@8.57.0)(typescript@5.6.2) + '@typescript-eslint/scope-manager': 7.18.0 + '@typescript-eslint/type-utils': 7.18.0(eslint@8.57.0)(typescript@5.6.2) + '@typescript-eslint/utils': 7.18.0(eslint@8.57.0)(typescript@5.6.2) + '@typescript-eslint/visitor-keys': 7.18.0 + eslint: 8.57.0 + graphemer: 1.4.0 + ignore: 5.3.2 + natural-compare: 1.4.0 + ts-api-utils: 1.3.0(typescript@5.6.2) + optionalDependencies: + typescript: 5.6.2 + transitivePeerDependencies: + - supports-color + + '@typescript-eslint/parser@7.18.0(eslint@8.57.0)(typescript@5.6.2)': + dependencies: + '@typescript-eslint/scope-manager': 7.18.0 + '@typescript-eslint/types': 7.18.0 + '@typescript-eslint/typescript-estree': 7.18.0(typescript@5.6.2) + '@typescript-eslint/visitor-keys': 7.18.0 + debug: 4.3.7(supports-color@8.1.1) + eslint: 8.57.0 + optionalDependencies: + typescript: 5.6.2 + transitivePeerDependencies: + - supports-color + + '@typescript-eslint/scope-manager@7.18.0': + dependencies: + '@typescript-eslint/types': 7.18.0 + '@typescript-eslint/visitor-keys': 7.18.0 + + '@typescript-eslint/type-utils@7.18.0(eslint@8.57.0)(typescript@5.6.2)': + dependencies: + '@typescript-eslint/typescript-estree': 7.18.0(typescript@5.6.2) + '@typescript-eslint/utils': 7.18.0(eslint@8.57.0)(typescript@5.6.2) + debug: 4.3.7(supports-color@8.1.1) + eslint: 8.57.0 + ts-api-utils: 1.3.0(typescript@5.6.2) + optionalDependencies: + typescript: 5.6.2 + transitivePeerDependencies: + - supports-color + + '@typescript-eslint/types@7.18.0': {} + + '@typescript-eslint/typescript-estree@7.18.0(typescript@5.6.2)': + dependencies: + '@typescript-eslint/types': 7.18.0 + '@typescript-eslint/visitor-keys': 7.18.0 + debug: 4.3.7(supports-color@8.1.1) + globby: 11.1.0 + is-glob: 4.0.3 + minimatch: 9.0.5 + semver: 7.6.3 + ts-api-utils: 1.3.0(typescript@5.6.2) + optionalDependencies: + typescript: 5.6.2 + transitivePeerDependencies: + - supports-color + + '@typescript-eslint/utils@7.18.0(eslint@8.57.0)(typescript@5.6.2)': + dependencies: + '@eslint-community/eslint-utils': 4.4.0(eslint@8.57.0) + '@typescript-eslint/scope-manager': 7.18.0 + '@typescript-eslint/types': 7.18.0 + '@typescript-eslint/typescript-estree': 7.18.0(typescript@5.6.2) + eslint: 8.57.0 + transitivePeerDependencies: + - supports-color + - typescript + + '@typescript-eslint/visitor-keys@7.18.0': + dependencies: + '@typescript-eslint/types': 7.18.0 + eslint-visitor-keys: 3.4.3 + + '@ungap/structured-clone@1.2.0': {} + + '@vue/compiler-core@3.5.4': + dependencies: + '@babel/parser': 7.25.6 + '@vue/shared': 3.5.4 + entities: 4.5.0 + estree-walker: 2.0.2 + source-map-js: 1.2.1 + + '@vue/compiler-dom@3.5.4': + dependencies: + '@vue/compiler-core': 3.5.4 + '@vue/shared': 3.5.4 + + '@vue/compiler-sfc@3.5.4': + dependencies: + '@babel/parser': 7.25.6 + '@vue/compiler-core': 3.5.4 + '@vue/compiler-dom': 3.5.4 + '@vue/compiler-ssr': 3.5.4 + '@vue/shared': 3.5.4 + estree-walker: 2.0.2 + magic-string: 0.30.11 + postcss: 8.4.45 + source-map-js: 1.2.1 + + '@vue/compiler-ssr@3.5.4': + dependencies: + '@vue/compiler-dom': 3.5.4 + '@vue/shared': 3.5.4 + + '@vue/shared@3.5.4': {} + + JSONStream@1.3.5: + dependencies: + jsonparse: 1.3.1 + through: 2.3.8 + + abbrev@1.0.9: {} + + abitype@0.9.10(typescript@5.6.2): + optionalDependencies: + typescript: 5.6.2 + + abitype@1.0.5(typescript@5.6.2): + optionalDependencies: + typescript: 5.6.2 + + acorn-jsx@5.3.2(acorn@8.12.1): + dependencies: + acorn: 8.12.1 + + acorn-walk@8.3.4: + dependencies: + acorn: 8.12.1 + + acorn@8.12.1: {} + + adm-zip@0.4.16: {} + + aes-js@3.0.0: {} + + aes-js@4.0.0-beta.5: {} + + agent-base@6.0.2: + dependencies: + debug: 4.3.7(supports-color@8.1.1) + transitivePeerDependencies: + - supports-color + + aggregate-error@3.1.0: + dependencies: + clean-stack: 2.2.0 + indent-string: 4.0.0 + + ajv@6.12.6: + dependencies: + fast-deep-equal: 3.1.3 + fast-json-stable-stringify: 2.1.0 + json-schema-traverse: 0.4.1 + uri-js: 4.4.1 + + ajv@8.17.1: + dependencies: + fast-deep-equal: 3.1.3 + fast-uri: 3.0.1 + json-schema-traverse: 1.0.0 + require-from-string: 2.0.2 + + amazon-cognito-identity-js@6.3.12: + dependencies: + '@aws-crypto/sha256-js': 1.2.2 + buffer: 4.9.2 + fast-base64-decode: 1.0.0 + isomorphic-unfetch: 3.1.0 + js-cookie: 2.2.1 + transitivePeerDependencies: + - encoding + + amdefine@1.0.1: + optional: true + + ansi-align@3.0.1: + dependencies: + string-width: 4.2.3 + + ansi-colors@4.1.3: {} + + ansi-escapes@4.3.2: + dependencies: + type-fest: 0.21.3 + + ansi-escapes@5.0.0: + dependencies: + type-fest: 1.4.0 + + ansi-regex@3.0.1: {} + + ansi-regex@5.0.1: {} + + ansi-regex@6.1.0: {} + + ansi-styles@3.2.1: + dependencies: + color-convert: 1.9.3 + + ansi-styles@4.3.0: + dependencies: + color-convert: 2.0.1 + + ansi-styles@6.2.1: {} + + antlr4@4.13.2: {} + + antlr4ts@0.5.0-alpha.4: {} + + anymatch@3.1.3: + dependencies: + normalize-path: 3.0.0 + picomatch: 2.3.1 + + arg@4.1.3: {} + + argparse@1.0.10: + dependencies: + sprintf-js: 1.0.3 + + argparse@2.0.1: {} + + array-back@3.1.0: {} + + array-back@4.0.2: {} + + array-ify@1.0.0: {} + + array-union@2.1.0: {} + + array-uniq@1.0.3: {} + + arrify@1.0.1: {} + + asap@2.0.6: {} + + assertion-error@1.1.0: {} + + ast-parents@0.0.1: {} + + astral-regex@2.0.0: {} + + async-retry@1.3.3: + dependencies: + retry: 0.13.1 + + async@1.5.2: {} + + asynckit@0.4.0: {} + + at-least-node@1.0.0: {} + + axios@0.21.4(debug@4.3.7): + dependencies: + follow-redirects: 1.15.9(debug@4.3.7) + transitivePeerDependencies: + - debug + + axios@0.27.2: + dependencies: + follow-redirects: 1.15.9(debug@4.3.7) + form-data: 4.0.0 + transitivePeerDependencies: + - debug + + axios@1.7.7(debug@4.3.7): + dependencies: + follow-redirects: 1.15.9(debug@4.3.7) + form-data: 4.0.0 + proxy-from-env: 1.1.0 + transitivePeerDependencies: + - debug + + balanced-match@1.0.2: {} + + base-x@3.0.10: + dependencies: + safe-buffer: 5.2.1 + + base64-js@1.5.1: {} + + bech32@1.1.4: {} + + binary-extensions@2.3.0: {} + + bl@4.1.0: + dependencies: + buffer: 5.7.1 + inherits: 2.0.4 + readable-stream: 3.6.2 + + blakejs@1.2.1: {} + + bn.js@4.11.6: {} + + bn.js@4.12.0: {} + + bn.js@5.2.1: {} + + boxen@5.1.2: + dependencies: + ansi-align: 3.0.1 + camelcase: 6.3.0 + chalk: 4.1.2 + cli-boxes: 2.2.1 + string-width: 4.2.3 + type-fest: 0.20.2 + widest-line: 3.1.0 + wrap-ansi: 7.0.0 + + brace-expansion@1.1.11: + dependencies: + balanced-match: 1.0.2 + concat-map: 0.0.1 + + brace-expansion@2.0.1: + dependencies: + balanced-match: 1.0.2 + + braces@3.0.3: + dependencies: + fill-range: 7.1.1 + + brorand@1.1.0: {} + + browser-stdout@1.3.1: {} + + browserify-aes@1.2.0: + dependencies: + buffer-xor: 1.0.3 + cipher-base: 1.0.4 + create-hash: 1.2.0 + evp_bytestokey: 1.0.3 + inherits: 2.0.4 + safe-buffer: 5.2.1 + + browserslist@4.23.3: + dependencies: + caniuse-lite: 1.0.30001660 + electron-to-chromium: 1.5.19 + node-releases: 2.0.18 + update-browserslist-db: 1.1.0(browserslist@4.23.3) + + bs58@4.0.1: + dependencies: + base-x: 3.0.10 + + bs58check@2.1.2: + dependencies: + bs58: 4.0.1 + create-hash: 1.2.0 + safe-buffer: 5.2.1 + + buffer-from@1.1.2: {} + + buffer-xor@1.0.3: {} + + buffer@4.9.2: + dependencies: + base64-js: 1.5.1 + ieee754: 1.2.1 + isarray: 1.0.0 + + buffer@5.7.1: + dependencies: + base64-js: 1.5.1 + ieee754: 1.2.1 + + bufio@1.2.1: {} + + builtin-modules@3.3.0: {} + + builtins@2.0.1: + dependencies: + semver: 6.3.1 + + bytes@3.1.2: {} + + cachedir@2.3.0: {} + + call-bind@1.0.7: + dependencies: + es-define-property: 1.0.0 + es-errors: 1.3.0 + function-bind: 1.1.2 + get-intrinsic: 1.2.4 + set-function-length: 1.2.2 + + callsites@3.1.0: {} + + camelcase-keys@6.2.2: + dependencies: + camelcase: 5.3.1 + map-obj: 4.3.0 + quick-lru: 4.0.1 + + camelcase@5.3.1: {} + + camelcase@6.3.0: {} + + caniuse-lite@1.0.30001660: {} + + caseless@0.12.0: {} + + cbor@8.1.0: + dependencies: + nofilter: 3.1.0 + + cbor@9.0.2: + dependencies: + nofilter: 3.1.0 + + chai-as-promised@7.1.2(chai@4.5.0): + dependencies: + chai: 4.5.0 + check-error: 1.0.3 + + chai@4.5.0: + dependencies: + assertion-error: 1.1.0 + check-error: 1.0.3 + deep-eql: 4.1.4 + get-func-name: 2.0.2 + loupe: 2.3.7 + pathval: 1.1.1 + type-detect: 4.1.0 + + chalk@2.4.2: + dependencies: + ansi-styles: 3.2.1 + escape-string-regexp: 1.0.5 + supports-color: 5.5.0 + + chalk@4.1.2: + dependencies: + ansi-styles: 4.3.0 + supports-color: 7.2.0 + + chalk@5.3.0: {} + + chardet@0.7.0: {} + + charenc@0.0.2: {} + + check-error@1.0.3: + dependencies: + get-func-name: 2.0.2 + + chokidar@3.6.0: + dependencies: + anymatch: 3.1.3 + braces: 3.0.3 + glob-parent: 5.1.2 + is-binary-path: 2.1.0 + is-glob: 4.0.3 + normalize-path: 3.0.0 + readdirp: 3.6.0 + optionalDependencies: + fsevents: 2.3.3 + + ci-info@2.0.0: {} + + cipher-base@1.0.4: + dependencies: + inherits: 2.0.4 + safe-buffer: 5.2.1 + + clean-stack@2.2.0: {} + + cli-boxes@2.2.1: {} + + cli-cursor@3.1.0: + dependencies: + restore-cursor: 3.1.0 + + cli-cursor@4.0.0: + dependencies: + restore-cursor: 4.0.0 + + cli-spinners@2.9.2: {} + + cli-table3@0.5.1: + dependencies: + object-assign: 4.1.1 + string-width: 2.1.1 + optionalDependencies: + colors: 1.4.0 + + cli-table3@0.6.5: + dependencies: + string-width: 4.2.3 + optionalDependencies: + '@colors/colors': 1.5.0 + + cli-truncate@3.1.0: + dependencies: + slice-ansi: 5.0.0 + string-width: 5.1.2 + + cli-width@3.0.0: {} + + cliui@7.0.4: + dependencies: + string-width: 4.2.3 + strip-ansi: 6.0.1 + wrap-ansi: 7.0.0 + + cliui@8.0.1: + dependencies: + string-width: 4.2.3 + strip-ansi: 6.0.1 + wrap-ansi: 7.0.0 + + clone@1.0.4: {} + + color-convert@1.9.3: + dependencies: + color-name: 1.1.3 + + color-convert@2.0.1: + dependencies: + color-name: 1.1.4 + + color-name@1.1.3: {} + + color-name@1.1.4: {} + + colorette@2.0.20: {} + + colors@1.4.0: {} + + combined-stream@1.0.8: + dependencies: + delayed-stream: 1.0.0 + + command-exists@1.2.9: {} + + command-line-args@5.2.1: + dependencies: + array-back: 3.1.0 + find-replace: 3.0.0 + lodash.camelcase: 4.3.0 + typical: 4.0.0 + + command-line-usage@6.1.3: + dependencies: + array-back: 4.0.2 + chalk: 2.4.2 + table-layout: 1.0.2 + typical: 5.2.0 + + commander@10.0.1: {} + + commander@11.0.0: {} + + commander@8.3.0: {} + + commander@9.5.0: {} + + commitizen@4.3.0(@types/node@18.19.50)(typescript@5.6.2): + dependencies: + cachedir: 2.3.0 + cz-conventional-changelog: 3.3.0(@types/node@18.19.50)(typescript@5.6.2) + dedent: 0.7.0 + detect-indent: 6.1.0 + find-node-modules: 2.1.3 + find-root: 1.1.0 + fs-extra: 9.1.0 + glob: 7.2.3 + inquirer: 8.2.5 + is-utf8: 0.2.1 + lodash: 4.17.21 + minimist: 1.2.7 + strip-bom: 4.0.0 + strip-json-comments: 3.1.1 + transitivePeerDependencies: + - '@types/node' + - typescript + + commondir@1.0.1: {} + + compare-func@2.0.0: + dependencies: + array-ify: 1.0.0 + dot-prop: 5.3.0 + + compare-versions@6.1.1: {} + + concat-map@0.0.1: {} + + concat-stream@1.6.2: + dependencies: + buffer-from: 1.1.2 + inherits: 2.0.4 + readable-stream: 2.3.8 + typedarray: 0.0.6 + + conventional-changelog-angular@6.0.0: + dependencies: + compare-func: 2.0.0 + + conventional-changelog-conventionalcommits@6.1.0: + dependencies: + compare-func: 2.0.0 + + conventional-commit-types@3.0.0: {} + + conventional-commits-parser@4.0.0: + dependencies: + JSONStream: 1.3.5 + is-text-path: 1.0.1 + meow: 8.1.2 + split2: 3.2.2 + + convert-source-map@1.9.0: {} + + cookie@0.4.2: {} + + core-util-is@1.0.3: {} + + cosmiconfig-typescript-loader@4.4.0(@types/node@20.5.1)(cosmiconfig@8.3.6(typescript@5.6.2))(ts-node@10.9.2(@swc/core@1.7.26)(@types/node@20.5.1)(typescript@5.6.2))(typescript@5.6.2): + dependencies: + '@types/node': 20.5.1 + cosmiconfig: 8.3.6(typescript@5.6.2) + ts-node: 10.9.2(@swc/core@1.7.26)(@types/node@20.5.1)(typescript@5.6.2) + typescript: 5.6.2 + + cosmiconfig-typescript-loader@5.0.0(@types/node@18.19.50)(cosmiconfig@9.0.0(typescript@5.6.2))(typescript@5.6.2): + dependencies: + '@types/node': 18.19.50 + cosmiconfig: 9.0.0(typescript@5.6.2) + jiti: 1.21.6 + typescript: 5.6.2 + optional: true + + cosmiconfig@8.3.6(typescript@5.6.2): + dependencies: + import-fresh: 3.3.0 + js-yaml: 4.1.0 + parse-json: 5.2.0 + path-type: 4.0.0 + optionalDependencies: + typescript: 5.6.2 + + cosmiconfig@9.0.0(typescript@5.6.2): + dependencies: + env-paths: 2.2.1 + import-fresh: 3.3.0 + js-yaml: 4.1.0 + parse-json: 5.2.0 + optionalDependencies: + typescript: 5.6.2 + optional: true + + create-hash@1.2.0: + dependencies: + cipher-base: 1.0.4 + inherits: 2.0.4 + md5.js: 1.3.5 + ripemd160: 2.0.2 + sha.js: 2.4.11 + + create-hmac@1.1.7: + dependencies: + cipher-base: 1.0.4 + create-hash: 1.2.0 + inherits: 2.0.4 + ripemd160: 2.0.2 + safe-buffer: 5.2.1 + sha.js: 2.4.11 + + create-require@1.1.1: {} + + cross-env@7.0.3: + dependencies: + cross-spawn: 7.0.3 + + cross-spawn@7.0.3: + dependencies: + path-key: 3.1.1 + shebang-command: 2.0.0 + which: 2.0.2 + + crypt@0.0.2: {} + + cz-conventional-changelog@3.3.0(@types/node@18.19.50)(typescript@5.6.2): + dependencies: + chalk: 2.4.2 + commitizen: 4.3.0(@types/node@18.19.50)(typescript@5.6.2) + conventional-commit-types: 3.0.0 + lodash.map: 4.6.0 + longest: 2.0.1 + word-wrap: 1.2.5 + optionalDependencies: + '@commitlint/load': 19.5.0(@types/node@18.19.50)(typescript@5.6.2) + transitivePeerDependencies: + - '@types/node' + - typescript + + dargs@7.0.0: {} + + death@1.1.0: {} + + debug@4.3.4: + dependencies: + ms: 2.1.2 + + debug@4.3.7(supports-color@8.1.1): + dependencies: + ms: 2.1.3 + optionalDependencies: + supports-color: 8.1.1 + + decamelize-keys@1.1.1: + dependencies: + decamelize: 1.2.0 + map-obj: 1.0.1 + + decamelize@1.2.0: {} + + decamelize@4.0.0: {} + + dedent@0.7.0: {} + + deep-eql@4.1.4: + dependencies: + type-detect: 4.1.0 + + deep-extend@0.6.0: {} + + deep-is@0.1.4: {} + + deepmerge@4.3.1: {} + + defaults@1.0.4: + dependencies: + clone: 1.0.4 + + define-data-property@1.1.4: + dependencies: + es-define-property: 1.0.0 + es-errors: 1.3.0 + gopd: 1.0.1 + + define-lazy-prop@2.0.0: {} + + delayed-stream@1.0.0: {} + + delete-empty@3.0.0: + dependencies: + ansi-colors: 4.1.3 + minimist: 1.2.8 + path-starts-with: 2.0.1 + rimraf: 2.7.1 + + depd@2.0.0: {} + + detect-file@1.0.0: {} + + detect-indent@6.1.0: {} + + diff@4.0.2: {} + + diff@5.2.0: {} + + difflib@0.2.4: + dependencies: + heap: 0.2.7 + + dir-glob@3.0.1: + dependencies: + path-type: 4.0.0 + + doctrine@3.0.0: + dependencies: + esutils: 2.0.3 + + dot-prop@5.3.0: + dependencies: + is-obj: 2.0.0 + + dotenv@16.4.5: {} + + eastasianwidth@0.2.0: {} + + electron-to-chromium@1.5.19: {} + + elliptic@6.5.4: + dependencies: + bn.js: 4.12.0 + brorand: 1.1.0 + hash.js: 1.1.7 + hmac-drbg: 1.0.1 + inherits: 2.0.4 + minimalistic-assert: 1.0.1 + minimalistic-crypto-utils: 1.0.1 + + elliptic@6.5.7: + dependencies: + bn.js: 4.12.0 + brorand: 1.1.0 + hash.js: 1.1.7 + hmac-drbg: 1.0.1 + inherits: 2.0.4 + minimalistic-assert: 1.0.1 + minimalistic-crypto-utils: 1.0.1 + + emoji-regex@8.0.0: {} + + emoji-regex@9.2.2: {} + + encode-utf8@1.0.3: {} + + enquirer@2.4.1: + dependencies: + ansi-colors: 4.1.3 + strip-ansi: 6.0.1 + + entities@4.5.0: {} + + env-paths@2.2.1: {} + + error-ex@1.3.2: + dependencies: + is-arrayish: 0.2.1 + + es-define-property@1.0.0: + dependencies: + get-intrinsic: 1.2.4 + + es-errors@1.3.0: {} + + es-module-lexer@1.5.4: {} + + esbuild@0.23.1: + optionalDependencies: + '@esbuild/aix-ppc64': 0.23.1 + '@esbuild/android-arm': 0.23.1 + '@esbuild/android-arm64': 0.23.1 + '@esbuild/android-x64': 0.23.1 + '@esbuild/darwin-arm64': 0.23.1 + '@esbuild/darwin-x64': 0.23.1 + '@esbuild/freebsd-arm64': 0.23.1 + '@esbuild/freebsd-x64': 0.23.1 + '@esbuild/linux-arm': 0.23.1 + '@esbuild/linux-arm64': 0.23.1 + '@esbuild/linux-ia32': 0.23.1 + '@esbuild/linux-loong64': 0.23.1 + '@esbuild/linux-mips64el': 0.23.1 + '@esbuild/linux-ppc64': 0.23.1 + '@esbuild/linux-riscv64': 0.23.1 + '@esbuild/linux-s390x': 0.23.1 + '@esbuild/linux-x64': 0.23.1 + '@esbuild/netbsd-x64': 0.23.1 + '@esbuild/openbsd-arm64': 0.23.1 + '@esbuild/openbsd-x64': 0.23.1 + '@esbuild/sunos-x64': 0.23.1 + '@esbuild/win32-arm64': 0.23.1 + '@esbuild/win32-ia32': 0.23.1 + '@esbuild/win32-x64': 0.23.1 + + escalade@3.2.0: {} + + escape-string-regexp@1.0.5: {} + + escape-string-regexp@4.0.0: {} + + escodegen@1.8.1: + dependencies: + esprima: 2.7.3 + estraverse: 1.9.3 + esutils: 2.0.3 + optionator: 0.8.3 + optionalDependencies: + source-map: 0.2.0 + + eslint-config-prettier@8.10.0(eslint@8.57.0): + dependencies: + eslint: 8.57.0 + + eslint-scope@7.2.2: + dependencies: + esrecurse: 4.3.0 + estraverse: 5.3.0 + + eslint-visitor-keys@3.4.3: {} + + eslint@8.57.0: + dependencies: + '@eslint-community/eslint-utils': 4.4.0(eslint@8.57.0) + '@eslint-community/regexpp': 4.11.0 + '@eslint/eslintrc': 2.1.4 + '@eslint/js': 8.57.0 + '@humanwhocodes/config-array': 0.11.14 + '@humanwhocodes/module-importer': 1.0.1 + '@nodelib/fs.walk': 1.2.8 + '@ungap/structured-clone': 1.2.0 + ajv: 6.12.6 + chalk: 4.1.2 + cross-spawn: 7.0.3 + debug: 4.3.7(supports-color@8.1.1) + doctrine: 3.0.0 + escape-string-regexp: 4.0.0 + eslint-scope: 7.2.2 + eslint-visitor-keys: 3.4.3 + espree: 9.6.1 + esquery: 1.6.0 + esutils: 2.0.3 + fast-deep-equal: 3.1.3 + file-entry-cache: 6.0.1 + find-up: 5.0.0 + glob-parent: 6.0.2 + globals: 13.24.0 + graphemer: 1.4.0 + ignore: 5.3.2 + imurmurhash: 0.1.4 + is-glob: 4.0.3 + is-path-inside: 3.0.3 + js-yaml: 4.1.0 + json-stable-stringify-without-jsonify: 1.0.1 + levn: 0.4.1 + lodash.merge: 4.6.2 + minimatch: 3.1.2 + natural-compare: 1.4.0 + optionator: 0.9.4 + strip-ansi: 6.0.1 + text-table: 0.2.0 + transitivePeerDependencies: + - supports-color + + espree@9.6.1: + dependencies: + acorn: 8.12.1 + acorn-jsx: 5.3.2(acorn@8.12.1) + eslint-visitor-keys: 3.4.3 + + esprima@2.7.3: {} + + esprima@4.0.1: {} + + esquery@1.6.0: + dependencies: + estraverse: 5.3.0 + + esrecurse@4.3.0: + dependencies: + estraverse: 5.3.0 + + estraverse@1.9.3: {} + + estraverse@5.3.0: {} + + estree-walker@0.6.1: {} + + estree-walker@2.0.2: {} + + esutils@2.0.3: {} + + eth-gas-reporter@0.2.27: + dependencies: + '@solidity-parser/parser': 0.14.5 + axios: 1.7.7(debug@4.3.7) + cli-table3: 0.5.1 + colors: 1.4.0 + ethereum-cryptography: 1.2.0 + ethers: 5.7.2 + fs-readdir-recursive: 1.1.0 + lodash: 4.17.21 + markdown-table: 1.1.3 + mocha: 10.7.3 + req-cwd: 2.0.0 + sha1: 1.1.1 + sync-request: 6.1.0 + transitivePeerDependencies: + - bufferutil + - debug + - utf-8-validate + + ethereum-bloom-filters@1.2.0: + dependencies: + '@noble/hashes': 1.5.0 + + ethereum-cryptography@0.1.3: + dependencies: + '@types/pbkdf2': 3.1.2 + '@types/secp256k1': 4.0.6 + blakejs: 1.2.1 + browserify-aes: 1.2.0 + bs58check: 2.1.2 + create-hash: 1.2.0 + create-hmac: 1.1.7 + hash.js: 1.1.7 + keccak: 3.0.4 + pbkdf2: 3.1.2 + randombytes: 2.1.0 + safe-buffer: 5.2.1 + scrypt-js: 3.0.1 + secp256k1: 4.0.3 + setimmediate: 1.0.5 + + ethereum-cryptography@1.2.0: + dependencies: + '@noble/hashes': 1.2.0 + '@noble/secp256k1': 1.7.1 + '@scure/bip32': 1.1.5 + '@scure/bip39': 1.1.1 + + ethereum-cryptography@2.2.1: + dependencies: + '@noble/curves': 1.4.2 + '@noble/hashes': 1.4.0 + '@scure/bip32': 1.4.0 + '@scure/bip39': 1.3.0 + + ethereumjs-abi@0.6.8: + dependencies: + bn.js: 4.12.0 + ethereumjs-util: 6.2.1 + + ethereumjs-util@6.2.1: + dependencies: + '@types/bn.js': 4.11.6 + bn.js: 4.12.0 + create-hash: 1.2.0 + elliptic: 6.5.7 + ethereum-cryptography: 0.1.3 + ethjs-util: 0.1.6 + rlp: 2.2.7 + + ethereumjs-util@7.1.5: + dependencies: + '@types/bn.js': 5.1.5 + bn.js: 5.2.1 + create-hash: 1.2.0 + ethereum-cryptography: 0.1.3 + rlp: 2.2.7 + + ethers@5.7.2: + dependencies: + '@ethersproject/abi': 5.7.0 + '@ethersproject/abstract-provider': 5.7.0 + '@ethersproject/abstract-signer': 5.7.0 + '@ethersproject/address': 5.7.0 + '@ethersproject/base64': 5.7.0 + '@ethersproject/basex': 5.7.0 + '@ethersproject/bignumber': 5.7.0 + '@ethersproject/bytes': 5.7.0 + '@ethersproject/constants': 5.7.0 + '@ethersproject/contracts': 5.7.0 + '@ethersproject/hash': 5.7.0 + '@ethersproject/hdnode': 5.7.0 + '@ethersproject/json-wallets': 5.7.0 + '@ethersproject/keccak256': 5.7.0 + '@ethersproject/logger': 5.7.0 + '@ethersproject/networks': 5.7.1 + '@ethersproject/pbkdf2': 5.7.0 + '@ethersproject/properties': 5.7.0 + '@ethersproject/providers': 5.7.2 + '@ethersproject/random': 5.7.0 + '@ethersproject/rlp': 5.7.0 + '@ethersproject/sha2': 5.7.0 + '@ethersproject/signing-key': 5.7.0 + '@ethersproject/solidity': 5.7.0 + '@ethersproject/strings': 5.7.0 + '@ethersproject/transactions': 5.7.0 + '@ethersproject/units': 5.7.0 + '@ethersproject/wallet': 5.7.0 + '@ethersproject/web': 5.7.1 + '@ethersproject/wordlists': 5.7.0 + transitivePeerDependencies: + - bufferutil + - utf-8-validate + + ethers@6.13.2: + dependencies: + '@adraffy/ens-normalize': 1.10.1 + '@noble/curves': 1.2.0 + '@noble/hashes': 1.3.2 + '@types/node': 18.15.13 + aes-js: 4.0.0-beta.5 + tslib: 2.4.0 + ws: 8.17.1 + transitivePeerDependencies: + - bufferutil + - utf-8-validate + + ethjs-unit@0.1.6: + dependencies: + bn.js: 4.11.6 + number-to-bn: 1.7.0 + + ethjs-util@0.1.6: + dependencies: + is-hex-prefixed: 1.0.0 + strip-hex-prefix: 1.0.0 + + eventemitter3@5.0.1: {} + + evp_bytestokey@1.0.3: + dependencies: + md5.js: 1.3.5 + safe-buffer: 5.2.1 + + execa@5.1.1: + dependencies: + cross-spawn: 7.0.3 + get-stream: 6.0.1 + human-signals: 2.1.0 + is-stream: 2.0.1 + merge-stream: 2.0.0 + npm-run-path: 4.0.1 + onetime: 5.1.2 + signal-exit: 3.0.7 + strip-final-newline: 2.0.0 + + execa@7.2.0: + dependencies: + cross-spawn: 7.0.3 + get-stream: 6.0.1 + human-signals: 4.3.1 + is-stream: 3.0.0 + merge-stream: 2.0.0 + npm-run-path: 5.3.0 + onetime: 6.0.0 + signal-exit: 3.0.7 + strip-final-newline: 3.0.0 + + expand-tilde@2.0.2: + dependencies: + homedir-polyfill: 1.0.3 + + external-editor@3.1.0: + dependencies: + chardet: 0.7.0 + iconv-lite: 0.4.24 + tmp: 0.0.33 + + fast-base64-decode@1.0.0: {} + + fast-deep-equal@3.1.3: {} + + fast-diff@1.3.0: {} + + fast-glob@3.3.2: + dependencies: + '@nodelib/fs.stat': 2.0.5 + '@nodelib/fs.walk': 1.2.8 + glob-parent: 5.1.2 + merge2: 1.4.1 + micromatch: 4.0.8 + + fast-json-stable-stringify@2.1.0: {} + + fast-levenshtein@2.0.6: {} + + fast-uri@3.0.1: {} + + fastq@1.17.1: + dependencies: + reusify: 1.0.4 + + figures@3.2.0: + dependencies: + escape-string-regexp: 1.0.5 + + file-entry-cache@6.0.1: + dependencies: + flat-cache: 3.2.0 + + fill-range@7.1.1: + dependencies: + to-regex-range: 5.0.1 + + find-node-modules@2.1.3: + dependencies: + findup-sync: 4.0.0 + merge: 2.1.1 + + find-replace@3.0.0: + dependencies: + array-back: 3.1.0 + + find-root@1.1.0: {} + + find-up@2.1.0: + dependencies: + locate-path: 2.0.0 + + find-up@4.1.0: + dependencies: + locate-path: 5.0.0 + path-exists: 4.0.0 + + find-up@5.0.0: + dependencies: + locate-path: 6.0.0 + path-exists: 4.0.0 + + findup-sync@4.0.0: + dependencies: + detect-file: 1.0.0 + is-glob: 4.0.3 + micromatch: 4.0.8 + resolve-dir: 1.0.1 + + flat-cache@3.2.0: + dependencies: + flatted: 3.3.1 + keyv: 4.5.4 + rimraf: 3.0.2 + + flat@5.0.2: {} + + flatted@3.3.1: {} + + fmix@0.1.0: + dependencies: + imul: 1.0.1 + + follow-redirects@1.15.9(debug@4.3.7): + optionalDependencies: + debug: 4.3.7(supports-color@8.1.1) + + foreground-child@3.3.0: + dependencies: + cross-spawn: 7.0.3 + signal-exit: 4.1.0 + + form-data@2.5.1: + dependencies: + asynckit: 0.4.0 + combined-stream: 1.0.8 + mime-types: 2.1.35 + + form-data@4.0.0: + dependencies: + asynckit: 0.4.0 + combined-stream: 1.0.8 + mime-types: 2.1.35 + + fp-ts@1.19.3: {} + + fs-extra@10.1.0: + dependencies: + graceful-fs: 4.2.11 + jsonfile: 6.1.0 + universalify: 2.0.1 + + fs-extra@11.2.0: + dependencies: + graceful-fs: 4.2.11 + jsonfile: 6.1.0 + universalify: 2.0.1 + + fs-extra@7.0.1: + dependencies: + graceful-fs: 4.2.11 + jsonfile: 4.0.0 + universalify: 0.1.2 + + fs-extra@8.1.0: + dependencies: + graceful-fs: 4.2.11 + jsonfile: 4.0.0 + universalify: 0.1.2 + + fs-extra@9.1.0: + dependencies: + at-least-node: 1.0.0 + graceful-fs: 4.2.11 + jsonfile: 6.1.0 + universalify: 2.0.1 + + fs-readdir-recursive@1.1.0: {} + + fs.realpath@1.0.0: {} + + fsevents@2.3.3: + optional: true + + function-bind@1.1.2: {} + + gensync@1.0.0-beta.2: {} + + get-caller-file@2.0.5: {} + + get-func-name@2.0.2: {} + + get-intrinsic@1.2.4: + dependencies: + es-errors: 1.3.0 + function-bind: 1.1.2 + has-proto: 1.0.3 + has-symbols: 1.0.3 + hasown: 2.0.2 + + get-port@3.2.0: {} + + get-stream@6.0.1: {} + + get-tsconfig@4.8.0: + dependencies: + resolve-pkg-maps: 1.0.0 + + ghost-testrpc@0.0.2: + dependencies: + chalk: 2.4.2 + node-emoji: 1.11.0 + + git-raw-commits@2.0.11: + dependencies: + dargs: 7.0.0 + lodash: 4.17.21 + meow: 8.1.2 + split2: 3.2.2 + through2: 4.0.2 + + glob-parent@5.1.2: + dependencies: + is-glob: 4.0.3 + + glob-parent@6.0.2: + dependencies: + is-glob: 4.0.3 + + glob@10.4.5: + dependencies: + foreground-child: 3.3.0 + jackspeak: 3.4.3 + minimatch: 9.0.5 + minipass: 7.1.2 + package-json-from-dist: 1.0.0 + path-scurry: 1.11.1 + + glob@5.0.15: + dependencies: + inflight: 1.0.6 + inherits: 2.0.4 + minimatch: 3.1.2 + once: 1.4.0 + path-is-absolute: 1.0.1 + + glob@7.1.7: + dependencies: + fs.realpath: 1.0.0 + inflight: 1.0.6 + inherits: 2.0.4 + minimatch: 3.1.2 + once: 1.4.0 + path-is-absolute: 1.0.1 + + glob@7.2.0: + dependencies: + fs.realpath: 1.0.0 + inflight: 1.0.6 + inherits: 2.0.4 + minimatch: 3.1.2 + once: 1.4.0 + path-is-absolute: 1.0.1 + + glob@7.2.3: + dependencies: + fs.realpath: 1.0.0 + inflight: 1.0.6 + inherits: 2.0.4 + minimatch: 3.1.2 + once: 1.4.0 + path-is-absolute: 1.0.1 + + glob@8.1.0: + dependencies: + fs.realpath: 1.0.0 + inflight: 1.0.6 + inherits: 2.0.4 + minimatch: 5.1.6 + once: 1.4.0 + + global-directory@4.0.1: + dependencies: + ini: 4.1.1 + optional: true + + global-dirs@0.1.1: + dependencies: + ini: 1.3.8 + + global-modules@1.0.0: + dependencies: + global-prefix: 1.0.2 + is-windows: 1.0.2 + resolve-dir: 1.0.1 + + global-modules@2.0.0: + dependencies: + global-prefix: 3.0.0 + + global-prefix@1.0.2: + dependencies: + expand-tilde: 2.0.2 + homedir-polyfill: 1.0.3 + ini: 1.3.8 + is-windows: 1.0.2 + which: 1.3.1 + + global-prefix@3.0.0: + dependencies: + ini: 1.3.8 + kind-of: 6.0.3 + which: 1.3.1 + + globals@11.12.0: {} + + globals@13.24.0: + dependencies: + type-fest: 0.20.2 + + globby@10.0.2: + dependencies: + '@types/glob': 7.2.0 + array-union: 2.1.0 + dir-glob: 3.0.1 + fast-glob: 3.3.2 + glob: 7.2.3 + ignore: 5.3.2 + merge2: 1.4.1 + slash: 3.0.0 + + globby@11.1.0: + dependencies: + array-union: 2.1.0 + dir-glob: 3.0.1 + fast-glob: 3.3.2 + ignore: 5.3.2 + merge2: 1.4.1 + slash: 3.0.0 + + gopd@1.0.1: + dependencies: + get-intrinsic: 1.2.4 + + graceful-fs@4.2.11: {} + + graphemer@1.4.0: {} + + handlebars@4.7.8: + dependencies: + minimist: 1.2.8 + neo-async: 2.6.2 + source-map: 0.6.1 + wordwrap: 1.0.0 + optionalDependencies: + uglify-js: 3.19.3 + + hard-rejection@2.1.0: {} + + hardhat-abi-exporter@2.10.1(hardhat@2.22.10(ts-node@10.9.2(@swc/core@1.7.26)(@types/node@18.19.50)(typescript@5.6.2))(typescript@5.6.2)): + dependencies: + '@ethersproject/abi': 5.7.0 + delete-empty: 3.0.0 + hardhat: 2.22.10(ts-node@10.9.2(@swc/core@1.7.26)(@types/node@18.19.50)(typescript@5.6.2))(typescript@5.6.2) + + hardhat-deploy@0.11.45: + dependencies: + '@ethersproject/abi': 5.7.0 + '@ethersproject/abstract-signer': 5.7.0 + '@ethersproject/address': 5.7.0 + '@ethersproject/bignumber': 5.7.0 + '@ethersproject/bytes': 5.7.0 + '@ethersproject/constants': 5.7.0 + '@ethersproject/contracts': 5.7.0 + '@ethersproject/providers': 5.7.2 + '@ethersproject/solidity': 5.7.0 + '@ethersproject/transactions': 5.7.0 + '@ethersproject/wallet': 5.7.0 + '@types/qs': 6.9.15 + axios: 0.21.4(debug@4.3.7) + chalk: 4.1.2 + chokidar: 3.6.0 + debug: 4.3.7(supports-color@8.1.1) + enquirer: 2.4.1 + ethers: 5.7.2 + form-data: 4.0.0 + fs-extra: 10.1.0 + match-all: 1.2.6 + murmur-128: 0.2.1 + qs: 6.13.0 + zksync-web3: 0.14.4(ethers@5.7.2) + transitivePeerDependencies: + - bufferutil + - supports-color + - utf-8-validate + + hardhat-gas-reporter@1.0.10(hardhat@2.22.10(ts-node@10.9.2(@swc/core@1.7.26)(@types/node@18.19.50)(typescript@5.6.2))(typescript@5.6.2)): + dependencies: + array-uniq: 1.0.3 + eth-gas-reporter: 0.2.27 + hardhat: 2.22.10(ts-node@10.9.2(@swc/core@1.7.26)(@types/node@18.19.50)(typescript@5.6.2))(typescript@5.6.2) + sha1: 1.1.1 + transitivePeerDependencies: + - '@codechecks/client' + - bufferutil + - debug + - utf-8-validate + + hardhat-preprocessor@0.1.5(hardhat@2.22.10(ts-node@10.9.2(@swc/core@1.7.26)(@types/node@18.19.50)(typescript@5.6.2))(typescript@5.6.2)): + dependencies: + hardhat: 2.22.10(ts-node@10.9.2(@swc/core@1.7.26)(@types/node@18.19.50)(typescript@5.6.2))(typescript@5.6.2) + murmur-128: 0.2.1 + + hardhat@2.22.10(ts-node@10.9.2(@swc/core@1.7.26)(@types/node@18.19.50)(typescript@5.6.2))(typescript@5.6.2): + dependencies: + '@ethersproject/abi': 5.7.0 + '@metamask/eth-sig-util': 4.0.1 + '@nomicfoundation/edr': 0.5.2 + '@nomicfoundation/ethereumjs-common': 4.0.4 + '@nomicfoundation/ethereumjs-tx': 5.0.4 + '@nomicfoundation/ethereumjs-util': 9.0.4 + '@nomicfoundation/solidity-analyzer': 0.1.2 + '@sentry/node': 5.30.0 + '@types/bn.js': 5.1.5 + '@types/lru-cache': 5.1.1 + adm-zip: 0.4.16 + aggregate-error: 3.1.0 + ansi-escapes: 4.3.2 + boxen: 5.1.2 + chalk: 2.4.2 + chokidar: 3.6.0 + ci-info: 2.0.0 + debug: 4.3.7(supports-color@8.1.1) + enquirer: 2.4.1 + env-paths: 2.2.1 + ethereum-cryptography: 1.2.0 + ethereumjs-abi: 0.6.8 + find-up: 2.1.0 + fp-ts: 1.19.3 + fs-extra: 7.0.1 + glob: 7.2.0 + immutable: 4.3.7 + io-ts: 1.10.4 + keccak: 3.0.4 + lodash: 4.17.21 + mnemonist: 0.38.5 + mocha: 10.7.3 + p-map: 4.0.0 + raw-body: 2.5.2 + resolve: 1.17.0 + semver: 6.3.1 + solc: 0.8.26(debug@4.3.7) + source-map-support: 0.5.21 + stacktrace-parser: 0.1.10 + tsort: 0.0.1 + undici: 5.28.4 + uuid: 8.3.2 + ws: 7.5.10 + optionalDependencies: + ts-node: 10.9.2(@swc/core@1.7.26)(@types/node@18.19.50)(typescript@5.6.2) + typescript: 5.6.2 + transitivePeerDependencies: + - bufferutil + - c-kzg + - supports-color + - utf-8-validate + + has-flag@1.0.0: {} + + has-flag@3.0.0: {} + + has-flag@4.0.0: {} + + has-property-descriptors@1.0.2: + dependencies: + es-define-property: 1.0.0 + + has-proto@1.0.3: {} + + has-symbols@1.0.3: {} + + hash-base@3.1.0: + dependencies: + inherits: 2.0.4 + readable-stream: 3.6.2 + safe-buffer: 5.2.1 + + hash.js@1.1.7: + dependencies: + inherits: 2.0.4 + minimalistic-assert: 1.0.1 + + hasown@2.0.2: + dependencies: + function-bind: 1.1.2 + + he@1.2.0: {} + + heap@0.2.7: {} + + hmac-drbg@1.0.1: + dependencies: + hash.js: 1.1.7 + minimalistic-assert: 1.0.1 + minimalistic-crypto-utils: 1.0.1 + + homedir-polyfill@1.0.3: + dependencies: + parse-passwd: 1.0.0 + + hosted-git-info@2.8.9: {} + + hosted-git-info@4.1.0: + dependencies: + lru-cache: 6.0.0 + + http-basic@8.1.3: + dependencies: + caseless: 0.12.0 + concat-stream: 1.6.2 + http-response-object: 3.0.2 + parse-cache-control: 1.0.1 + + http-errors@2.0.0: + dependencies: + depd: 2.0.0 + inherits: 2.0.4 + setprototypeof: 1.2.0 + statuses: 2.0.1 + toidentifier: 1.0.1 + + http-response-object@3.0.2: + dependencies: + '@types/node': 10.17.60 + + https-proxy-agent@5.0.1: + dependencies: + agent-base: 6.0.2 + debug: 4.3.7(supports-color@8.1.1) + transitivePeerDependencies: + - supports-color + + human-signals@2.1.0: {} + + human-signals@4.3.1: {} + + husky@8.0.3: {} + + iconv-lite@0.4.24: + dependencies: + safer-buffer: 2.1.2 + + ieee754@1.2.1: {} + + ignore@5.3.2: {} + + immer@10.0.2: {} + + immutable@4.3.7: {} + + import-fresh@3.3.0: + dependencies: + parent-module: 1.0.1 + resolve-from: 4.0.0 + + import-meta-resolve@4.1.0: + optional: true + + imul@1.0.1: {} + + imurmurhash@0.1.4: {} + + indent-string@4.0.0: {} + + inflight@1.0.6: + dependencies: + once: 1.4.0 + wrappy: 1.0.2 + + inherits@2.0.4: {} + + ini@1.3.8: {} + + ini@4.1.1: + optional: true + + inquirer@8.2.5: + dependencies: + ansi-escapes: 4.3.2 + chalk: 4.1.2 + cli-cursor: 3.1.0 + cli-width: 3.0.0 + external-editor: 3.1.0 + figures: 3.2.0 + lodash: 4.17.21 + mute-stream: 0.0.8 + ora: 5.4.1 + run-async: 2.4.1 + rxjs: 7.8.1 + string-width: 4.2.3 + strip-ansi: 6.0.1 + through: 2.3.8 + wrap-ansi: 7.0.0 + + interpret@1.4.0: {} + + io-ts@1.10.4: + dependencies: + fp-ts: 1.19.3 + + is-arrayish@0.2.1: {} + + is-binary-path@2.1.0: + dependencies: + binary-extensions: 2.3.0 + + is-builtin-module@3.2.1: + dependencies: + builtin-modules: 3.3.0 + + is-core-module@2.15.1: + dependencies: + hasown: 2.0.2 + + is-docker@2.2.1: {} + + is-extglob@2.1.1: {} + + is-fullwidth-code-point@2.0.0: {} + + is-fullwidth-code-point@3.0.0: {} + + is-fullwidth-code-point@4.0.0: {} + + is-glob@4.0.3: + dependencies: + is-extglob: 2.1.1 + + is-hex-prefixed@1.0.0: {} + + is-interactive@1.0.0: {} + + is-module@1.0.0: {} + + is-number@7.0.0: {} + + is-obj@2.0.0: {} + + is-path-inside@3.0.3: {} + + is-plain-obj@1.1.0: {} + + is-plain-obj@2.1.0: {} + + is-reference@1.2.1: + dependencies: + '@types/estree': 1.0.5 + + is-stream@2.0.1: {} + + is-stream@3.0.0: {} + + is-text-path@1.0.1: + dependencies: + text-extensions: 1.9.0 + + is-unicode-supported@0.1.0: {} + + is-utf8@0.2.1: {} + + is-windows@1.0.2: {} + + is-wsl@2.2.0: + dependencies: + is-docker: 2.2.1 + + isarray@1.0.0: {} + + isexe@2.0.0: {} + + isomorphic-unfetch@3.1.0: + dependencies: + node-fetch: 2.7.0 + unfetch: 4.2.0 + transitivePeerDependencies: + - encoding + + isows@1.0.4(ws@8.17.1): + dependencies: + ws: 8.17.1 + + jackspeak@3.4.3: + dependencies: + '@isaacs/cliui': 8.0.2 + optionalDependencies: + '@pkgjs/parseargs': 0.11.0 + + javascript-natural-sort@0.7.1: {} + + jiti@1.21.6: + optional: true + + js-cookie@2.2.1: {} + + js-sha3@0.8.0: {} + + js-tokens@4.0.0: {} + + js-yaml@3.14.1: + dependencies: + argparse: 1.0.10 + esprima: 4.0.1 + + js-yaml@4.1.0: + dependencies: + argparse: 2.0.1 + + jsesc@2.5.2: {} + + json-buffer@3.0.1: {} + + json-parse-better-errors@1.0.2: {} + + json-parse-even-better-errors@2.3.1: {} + + json-schema-traverse@0.4.1: {} + + json-schema-traverse@1.0.0: {} + + json-stable-stringify-without-jsonify@1.0.1: {} + + json-stringify-safe@5.0.1: {} + + json5@2.2.3: {} + + jsonfile@4.0.0: + optionalDependencies: + graceful-fs: 4.2.11 + + jsonfile@6.1.0: + dependencies: + universalify: 2.0.1 + optionalDependencies: + graceful-fs: 4.2.11 + + jsonparse@1.3.1: {} + + jsonschema@1.4.1: {} + + keccak@3.0.4: + dependencies: + node-addon-api: 2.0.2 + node-gyp-build: 4.8.2 + readable-stream: 3.6.2 + + keyv@4.5.4: + dependencies: + json-buffer: 3.0.1 + + kind-of@6.0.3: {} + + kleur@3.0.3: {} + + levn@0.3.0: + dependencies: + prelude-ls: 1.1.2 + type-check: 0.3.2 + + levn@0.4.1: + dependencies: + prelude-ls: 1.2.1 + type-check: 0.4.0 + + lilconfig@2.1.0: {} + + lines-and-columns@1.2.4: {} + + lint-staged@13.3.0(enquirer@2.4.1): + dependencies: + chalk: 5.3.0 + commander: 11.0.0 + debug: 4.3.4 + execa: 7.2.0 + lilconfig: 2.1.0 + listr2: 6.6.1(enquirer@2.4.1) + micromatch: 4.0.5 + pidtree: 0.6.0 + string-argv: 0.3.2 + yaml: 2.3.1 + transitivePeerDependencies: + - enquirer + - supports-color + + listr2@6.6.1(enquirer@2.4.1): + dependencies: + cli-truncate: 3.1.0 + colorette: 2.0.20 + eventemitter3: 5.0.1 + log-update: 5.0.1 + rfdc: 1.4.1 + wrap-ansi: 8.1.0 + optionalDependencies: + enquirer: 2.4.1 + + load-json-file@4.0.0: + dependencies: + graceful-fs: 4.2.11 + parse-json: 4.0.0 + pify: 3.0.0 + strip-bom: 3.0.0 + + locate-path@2.0.0: + dependencies: + p-locate: 2.0.0 + path-exists: 3.0.0 + + locate-path@5.0.0: + dependencies: + p-locate: 4.1.0 + + locate-path@6.0.0: + dependencies: + p-locate: 5.0.0 + + lodash.camelcase@4.3.0: {} + + lodash.clonedeep@4.5.0: {} + + lodash.isequal@4.5.0: {} + + lodash.isfunction@3.0.9: {} + + lodash.isplainobject@4.0.6: {} + + lodash.kebabcase@4.1.1: {} + + lodash.map@4.6.0: {} + + lodash.memoize@4.1.2: {} + + lodash.merge@4.6.2: {} + + lodash.mergewith@4.6.2: {} + + lodash.snakecase@4.1.1: {} + + lodash.startcase@4.4.0: {} + + lodash.truncate@4.4.2: {} + + lodash.uniq@4.5.0: {} + + lodash.upperfirst@4.3.1: {} + + lodash@4.17.21: {} + + log-symbols@4.1.0: + dependencies: + chalk: 4.1.2 + is-unicode-supported: 0.1.0 + + log-update@5.0.1: + dependencies: + ansi-escapes: 5.0.0 + cli-cursor: 4.0.0 + slice-ansi: 5.0.0 + strip-ansi: 7.1.0 + wrap-ansi: 8.1.0 + + longest@2.0.1: {} + + loupe@2.3.7: + dependencies: + get-func-name: 2.0.2 + + lru-cache@10.4.3: {} + + lru-cache@5.1.1: + dependencies: + yallist: 3.1.1 + + lru-cache@6.0.0: + dependencies: + yallist: 4.0.0 + + lru_map@0.3.3: {} + + magic-string@0.25.9: + dependencies: + sourcemap-codec: 1.4.8 + + magic-string@0.27.0: + dependencies: + '@jridgewell/sourcemap-codec': 1.5.0 + + magic-string@0.30.11: + dependencies: + '@jridgewell/sourcemap-codec': 1.5.0 + + make-error@1.3.6: {} + + map-obj@1.0.1: {} + + map-obj@4.3.0: {} + + markdown-table@1.1.3: {} + + match-all@1.2.6: {} + + md5.js@1.3.5: + dependencies: + hash-base: 3.1.0 + inherits: 2.0.4 + safe-buffer: 5.2.1 + + memorystream@0.3.1: {} + + meow@8.1.2: + dependencies: + '@types/minimist': 1.2.5 + camelcase-keys: 6.2.2 + decamelize-keys: 1.1.1 + hard-rejection: 2.1.0 + minimist-options: 4.1.0 + normalize-package-data: 3.0.3 + read-pkg-up: 7.0.1 + redent: 3.0.0 + trim-newlines: 3.0.1 + type-fest: 0.18.1 + yargs-parser: 20.2.9 + + merge-stream@2.0.0: {} + + merge2@1.4.1: {} + + merge@2.1.1: {} + + micro-ftch@0.3.1: {} + + micromatch@4.0.5: + dependencies: + braces: 3.0.3 + picomatch: 2.3.1 + + micromatch@4.0.8: + dependencies: + braces: 3.0.3 + picomatch: 2.3.1 + + mime-db@1.52.0: {} + + mime-types@2.1.35: + dependencies: + mime-db: 1.52.0 + + mimic-fn@2.1.0: {} + + mimic-fn@4.0.0: {} + + min-indent@1.0.1: {} + + minimalistic-assert@1.0.1: {} + + minimalistic-crypto-utils@1.0.1: {} + + minimatch@3.1.2: + dependencies: + brace-expansion: 1.1.11 + + minimatch@5.1.6: + dependencies: + brace-expansion: 2.0.1 + + minimatch@9.0.5: + dependencies: + brace-expansion: 2.0.1 + + minimist-options@4.1.0: + dependencies: + arrify: 1.0.1 + is-plain-obj: 1.1.0 + kind-of: 6.0.3 + + minimist@1.2.7: {} + + minimist@1.2.8: {} + + minipass@7.1.2: {} + + mkdirp@0.5.6: + dependencies: + minimist: 1.2.8 + + mkdirp@1.0.4: {} + + mnemonist@0.38.5: + dependencies: + obliterator: 2.0.4 + + mocha@10.7.3: + dependencies: + ansi-colors: 4.1.3 + browser-stdout: 1.3.1 + chokidar: 3.6.0 + debug: 4.3.7(supports-color@8.1.1) + diff: 5.2.0 + escape-string-regexp: 4.0.0 + find-up: 5.0.0 + glob: 8.1.0 + he: 1.2.0 + js-yaml: 4.1.0 + log-symbols: 4.1.0 + minimatch: 5.1.6 + ms: 2.1.3 + serialize-javascript: 6.0.2 + strip-json-comments: 3.1.1 + supports-color: 8.1.1 + workerpool: 6.5.1 + yargs: 16.2.0 + yargs-parser: 20.2.9 + yargs-unparser: 2.0.0 + + ms@2.1.2: {} + + ms@2.1.3: {} + + murmur-128@0.2.1: + dependencies: + encode-utf8: 1.0.3 + fmix: 0.1.0 + imul: 1.0.1 + + mute-stream@0.0.8: {} + + nanoid@3.3.7: {} + + natural-compare@1.4.0: {} + + ndjson@2.0.0: + dependencies: + json-stringify-safe: 5.0.1 + minimist: 1.2.8 + readable-stream: 3.6.2 + split2: 3.2.2 + through2: 4.0.2 + + neo-async@2.6.2: {} + + node-addon-api@2.0.2: {} + + node-emoji@1.11.0: + dependencies: + lodash: 4.17.21 + + node-fetch@2.7.0: + dependencies: + whatwg-url: 5.0.0 + + node-gyp-build@4.8.2: {} + + node-releases@2.0.18: {} + + nofilter@3.1.0: {} + + nopt@3.0.6: + dependencies: + abbrev: 1.0.9 + + normalize-package-data@2.5.0: + dependencies: + hosted-git-info: 2.8.9 + resolve: 1.22.8 + semver: 5.7.2 + validate-npm-package-license: 3.0.4 + + normalize-package-data@3.0.3: + dependencies: + hosted-git-info: 4.1.0 + is-core-module: 2.15.1 + semver: 7.6.3 + validate-npm-package-license: 3.0.4 + + normalize-path@3.0.0: {} + + npm-run-path@4.0.1: + dependencies: + path-key: 3.1.1 + + npm-run-path@5.3.0: + dependencies: + path-key: 4.0.0 + + number-to-bn@1.7.0: + dependencies: + bn.js: 4.11.6 + strip-hex-prefix: 1.0.0 + + object-assign@4.1.1: {} + + object-inspect@1.13.2: {} + + obliterator@2.0.4: {} + + once@1.4.0: + dependencies: + wrappy: 1.0.2 + + onetime@5.1.2: + dependencies: + mimic-fn: 2.1.0 + + onetime@6.0.0: + dependencies: + mimic-fn: 4.0.0 + + open@8.4.2: + dependencies: + define-lazy-prop: 2.0.0 + is-docker: 2.2.1 + is-wsl: 2.2.0 + + optionator@0.8.3: + dependencies: + deep-is: 0.1.4 + fast-levenshtein: 2.0.6 + levn: 0.3.0 + prelude-ls: 1.1.2 + type-check: 0.3.2 + word-wrap: 1.2.5 + + optionator@0.9.4: + dependencies: + deep-is: 0.1.4 + fast-levenshtein: 2.0.6 + levn: 0.4.1 + prelude-ls: 1.2.1 + type-check: 0.4.0 + word-wrap: 1.2.5 + + ora@5.4.1: + dependencies: + bl: 4.1.0 + chalk: 4.1.2 + cli-cursor: 3.1.0 + cli-spinners: 2.9.2 + is-interactive: 1.0.0 + is-unicode-supported: 0.1.0 + log-symbols: 4.1.0 + strip-ansi: 6.0.1 + wcwidth: 1.0.1 + + ordinal@1.0.3: {} + + os-tmpdir@1.0.2: {} + + p-limit@1.3.0: + dependencies: + p-try: 1.0.0 + + p-limit@2.3.0: + dependencies: + p-try: 2.2.0 + + p-limit@3.1.0: + dependencies: + yocto-queue: 0.1.0 + + p-locate@2.0.0: + dependencies: + p-limit: 1.3.0 + + p-locate@4.1.0: + dependencies: + p-limit: 2.3.0 + + p-locate@5.0.0: + dependencies: + p-limit: 3.1.0 + + p-map@4.0.0: + dependencies: + aggregate-error: 3.1.0 + + p-try@1.0.0: {} + + p-try@2.2.0: {} + + package-json-from-dist@1.0.0: {} + + parent-module@1.0.1: + dependencies: + callsites: 3.1.0 + + parse-cache-control@1.0.1: {} + + parse-json@4.0.0: + dependencies: + error-ex: 1.3.2 + json-parse-better-errors: 1.0.2 + + parse-json@5.2.0: + dependencies: + '@babel/code-frame': 7.24.7 + error-ex: 1.3.2 + json-parse-even-better-errors: 2.3.1 + lines-and-columns: 1.2.4 + + parse-passwd@1.0.0: {} + + path-exists@3.0.0: {} + + path-exists@4.0.0: {} + + path-is-absolute@1.0.1: {} + + path-key@3.1.1: {} + + path-key@4.0.0: {} + + path-parse@1.0.7: {} + + path-scurry@1.11.1: + dependencies: + lru-cache: 10.4.3 + minipass: 7.1.2 + + path-starts-with@2.0.1: {} + + path-type@3.0.0: + dependencies: + pify: 3.0.0 + + path-type@4.0.0: {} + + pathval@1.1.1: {} + + pbkdf2@3.1.2: + dependencies: + create-hash: 1.2.0 + create-hmac: 1.1.7 + ripemd160: 2.0.2 + safe-buffer: 5.2.1 + sha.js: 2.4.11 + + picocolors@1.1.0: {} + + picomatch@2.3.1: {} + + pidtree@0.6.0: {} + + pify@3.0.0: {} + + pify@4.0.1: {} + + pluralize@8.0.0: {} + + postcss@8.4.45: + dependencies: + nanoid: 3.3.7 + picocolors: 1.1.0 + source-map-js: 1.2.1 + + prelude-ls@1.1.2: {} + + prelude-ls@1.2.1: {} + + prettier-linter-helpers@1.0.0: + dependencies: + fast-diff: 1.3.0 + + prettier-plugin-solidity@1.4.1(prettier@2.8.8): + dependencies: + '@solidity-parser/parser': 0.18.0 + prettier: 2.8.8 + semver: 7.6.3 + + prettier@2.8.8: {} + + process-nextick-args@2.0.1: {} + + promise@8.3.0: + dependencies: + asap: 2.0.6 + + prompts@2.4.2: + dependencies: + kleur: 3.0.3 + sisteransi: 1.0.5 + + proper-lockfile@4.1.2: + dependencies: + graceful-fs: 4.2.11 + retry: 0.12.0 + signal-exit: 3.0.7 + + proxy-from-env@1.1.0: {} + + punycode@2.3.1: {} + + qs@6.13.0: + dependencies: + side-channel: 1.0.6 + + queue-microtask@1.2.3: {} + + quick-lru@4.0.1: {} + + randombytes@2.1.0: + dependencies: + safe-buffer: 5.2.1 + + raw-body@2.5.2: + dependencies: + bytes: 3.1.2 + http-errors: 2.0.0 + iconv-lite: 0.4.24 + unpipe: 1.0.0 + + read-pkg-up@7.0.1: + dependencies: + find-up: 4.1.0 + read-pkg: 5.2.0 + type-fest: 0.8.1 + + read-pkg@3.0.0: + dependencies: + load-json-file: 4.0.0 + normalize-package-data: 2.5.0 + path-type: 3.0.0 + + read-pkg@5.2.0: + dependencies: + '@types/normalize-package-data': 2.4.4 + normalize-package-data: 2.5.0 + parse-json: 5.2.0 + type-fest: 0.6.0 + + readable-stream@2.3.8: + dependencies: + core-util-is: 1.0.3 + inherits: 2.0.4 + isarray: 1.0.0 + process-nextick-args: 2.0.1 + safe-buffer: 5.1.2 + string_decoder: 1.1.1 + util-deprecate: 1.0.2 + + readable-stream@3.6.2: + dependencies: + inherits: 2.0.4 + string_decoder: 1.3.0 + util-deprecate: 1.0.2 + + readdirp@3.6.0: + dependencies: + picomatch: 2.3.1 + + rechoir@0.6.2: + dependencies: + resolve: 1.22.8 + + recursive-readdir@2.2.3: + dependencies: + minimatch: 3.1.2 + + redent@3.0.0: + dependencies: + indent-string: 4.0.0 + strip-indent: 3.0.0 + + reduce-flatten@2.0.0: {} + + req-cwd@2.0.0: + dependencies: + req-from: 2.0.0 + + req-from@2.0.0: + dependencies: + resolve-from: 3.0.0 + + require-directory@2.1.1: {} + + require-from-string@2.0.2: {} + + resolve-dir@1.0.1: + dependencies: + expand-tilde: 2.0.2 + global-modules: 1.0.0 + + resolve-from@3.0.0: {} + + resolve-from@4.0.0: {} + + resolve-from@5.0.0: {} + + resolve-global@1.0.0: + dependencies: + global-dirs: 0.1.1 + + resolve-pkg-maps@1.0.0: {} + + resolve@1.1.7: {} + + resolve@1.17.0: + dependencies: + path-parse: 1.0.7 + + resolve@1.22.8: + dependencies: + is-core-module: 2.15.1 + path-parse: 1.0.7 + supports-preserve-symlinks-flag: 1.0.0 + + restore-cursor@3.1.0: + dependencies: + onetime: 5.1.2 + signal-exit: 3.0.7 + + restore-cursor@4.0.0: + dependencies: + onetime: 5.1.2 + signal-exit: 3.0.7 + + retry@0.12.0: {} + + retry@0.13.1: {} + + reusify@1.0.4: {} + + rfdc@1.4.1: {} + + rimraf@2.7.1: + dependencies: + glob: 7.2.3 + + rimraf@3.0.2: + dependencies: + glob: 7.2.3 + + rimraf@5.0.10: + dependencies: + glob: 10.4.5 + + ripemd160@2.0.2: + dependencies: + hash-base: 3.1.0 + inherits: 2.0.4 + + rlp@2.2.7: + dependencies: + bn.js: 5.2.1 + + rollup-plugin-auto-external@2.0.0(rollup@4.21.2): + dependencies: + builtins: 2.0.1 + read-pkg: 3.0.0 + rollup: 4.21.2 + safe-resolve: 1.0.0 + semver: 5.7.2 + + rollup-plugin-dts@6.1.1(rollup@4.21.2)(typescript@5.6.2): + dependencies: + magic-string: 0.30.11 + rollup: 4.21.2 + typescript: 5.6.2 + optionalDependencies: + '@babel/code-frame': 7.24.7 + + rollup-plugin-esbuild@6.1.1(esbuild@0.23.1)(rollup@4.21.2): + dependencies: + '@rollup/pluginutils': 5.1.0(rollup@4.21.2) + debug: 4.3.7(supports-color@8.1.1) + es-module-lexer: 1.5.4 + esbuild: 0.23.1 + get-tsconfig: 4.8.0 + rollup: 4.21.2 + transitivePeerDependencies: + - supports-color + + rollup-plugin-inject@3.0.2: + dependencies: + estree-walker: 0.6.1 + magic-string: 0.25.9 + rollup-pluginutils: 2.8.2 + + rollup-plugin-node-polyfills@0.2.1: + dependencies: + rollup-plugin-inject: 3.0.2 + + rollup-plugin-swc3@0.11.2(@swc/core@1.7.26)(rollup@4.21.2): + dependencies: + '@fastify/deepmerge': 1.3.0 + '@rollup/pluginutils': 5.1.0(rollup@4.21.2) + '@swc/core': 1.7.26 + get-tsconfig: 4.8.0 + rollup: 4.21.2 + rollup-preserve-directives: 1.1.1(rollup@4.21.2) + + rollup-pluginutils@2.8.2: + dependencies: + estree-walker: 0.6.1 + + rollup-preserve-directives@1.1.1(rollup@4.21.2): + dependencies: + magic-string: 0.30.11 + rollup: 4.21.2 + + rollup@4.21.2: + dependencies: + '@types/estree': 1.0.5 + optionalDependencies: + '@rollup/rollup-android-arm-eabi': 4.21.2 + '@rollup/rollup-android-arm64': 4.21.2 + '@rollup/rollup-darwin-arm64': 4.21.2 + '@rollup/rollup-darwin-x64': 4.21.2 + '@rollup/rollup-linux-arm-gnueabihf': 4.21.2 + '@rollup/rollup-linux-arm-musleabihf': 4.21.2 + '@rollup/rollup-linux-arm64-gnu': 4.21.2 + '@rollup/rollup-linux-arm64-musl': 4.21.2 + '@rollup/rollup-linux-powerpc64le-gnu': 4.21.2 + '@rollup/rollup-linux-riscv64-gnu': 4.21.2 + '@rollup/rollup-linux-s390x-gnu': 4.21.2 + '@rollup/rollup-linux-x64-gnu': 4.21.2 + '@rollup/rollup-linux-x64-musl': 4.21.2 + '@rollup/rollup-win32-arm64-msvc': 4.21.2 + '@rollup/rollup-win32-ia32-msvc': 4.21.2 + '@rollup/rollup-win32-x64-msvc': 4.21.2 + fsevents: 2.3.3 + + run-async@2.4.1: {} + + run-parallel@1.2.0: + dependencies: + queue-microtask: 1.2.3 + + rxjs@7.8.1: + dependencies: + tslib: 2.7.0 + + safe-buffer@5.1.2: {} + + safe-buffer@5.2.1: {} + + safe-resolve@1.0.0: {} + + safer-buffer@2.1.2: {} + + sc-istanbul@0.4.6: + dependencies: + abbrev: 1.0.9 + async: 1.5.2 + escodegen: 1.8.1 + esprima: 2.7.3 + glob: 5.0.15 + handlebars: 4.7.8 + js-yaml: 3.14.1 + mkdirp: 0.5.6 + nopt: 3.0.6 + once: 1.4.0 + resolve: 1.1.7 + supports-color: 3.2.3 + which: 1.3.1 + wordwrap: 1.0.0 + + scrypt-js@3.0.1: {} + + secp256k1@4.0.3: + dependencies: + elliptic: 6.5.7 + node-addon-api: 2.0.2 + node-gyp-build: 4.8.2 + + semver@5.7.2: {} + + semver@6.3.1: {} + + semver@7.5.4: + dependencies: + lru-cache: 6.0.0 + + semver@7.6.3: {} + + serialize-javascript@6.0.2: + dependencies: + randombytes: 2.1.0 + + set-function-length@1.2.2: + dependencies: + define-data-property: 1.1.4 + es-errors: 1.3.0 + function-bind: 1.1.2 + get-intrinsic: 1.2.4 + gopd: 1.0.1 + has-property-descriptors: 1.0.2 + + setimmediate@1.0.5: {} + + setprototypeof@1.2.0: {} + + sha.js@2.4.11: + dependencies: + inherits: 2.0.4 + safe-buffer: 5.2.1 + + sha1@1.1.1: + dependencies: + charenc: 0.0.2 + crypt: 0.0.2 + + shebang-command@2.0.0: + dependencies: + shebang-regex: 3.0.0 + + shebang-regex@3.0.0: {} + + shelljs@0.8.5: + dependencies: + glob: 7.2.3 + interpret: 1.4.0 + rechoir: 0.6.2 + + shx@0.3.4: + dependencies: + minimist: 1.2.8 + shelljs: 0.8.5 + + side-channel@1.0.6: + dependencies: + call-bind: 1.0.7 + es-errors: 1.3.0 + get-intrinsic: 1.2.4 + object-inspect: 1.13.2 + + signal-exit@3.0.7: {} + + signal-exit@4.1.0: {} + + sisteransi@1.0.5: {} + + slash@3.0.0: {} + + slice-ansi@4.0.0: + dependencies: + ansi-styles: 4.3.0 + astral-regex: 2.0.0 + is-fullwidth-code-point: 3.0.0 + + slice-ansi@5.0.0: + dependencies: + ansi-styles: 6.2.1 + is-fullwidth-code-point: 4.0.0 + + solc@0.8.26(debug@4.3.7): + dependencies: + command-exists: 1.2.9 + commander: 8.3.0 + follow-redirects: 1.15.9(debug@4.3.7) + js-sha3: 0.8.0 + memorystream: 0.3.1 + semver: 5.7.2 + tmp: 0.0.33 + transitivePeerDependencies: + - debug + + solhint-plugin-prettier@0.0.5(prettier-plugin-solidity@1.4.1(prettier@2.8.8))(prettier@2.8.8): + dependencies: + prettier: 2.8.8 + prettier-linter-helpers: 1.0.0 + prettier-plugin-solidity: 1.4.1(prettier@2.8.8) + + solhint@3.6.2(typescript@5.6.2): + dependencies: + '@solidity-parser/parser': 0.16.2 + ajv: 6.12.6 + antlr4: 4.13.2 + ast-parents: 0.0.1 + chalk: 4.1.2 + commander: 10.0.1 + cosmiconfig: 8.3.6(typescript@5.6.2) + fast-diff: 1.3.0 + glob: 8.1.0 + ignore: 5.3.2 + js-yaml: 4.1.0 + lodash: 4.17.21 + pluralize: 8.0.0 + semver: 7.6.3 + strip-ansi: 6.0.1 + table: 6.8.2 + text-table: 0.2.0 + optionalDependencies: + prettier: 2.8.8 + transitivePeerDependencies: + - typescript + + solidity-ast@0.4.59: {} + + solidity-coverage@0.8.13(hardhat@2.22.10(ts-node@10.9.2(@swc/core@1.7.26)(@types/node@18.19.50)(typescript@5.6.2))(typescript@5.6.2)): + dependencies: + '@ethersproject/abi': 5.7.0 + '@solidity-parser/parser': 0.18.0 + chalk: 2.4.2 + death: 1.1.0 + difflib: 0.2.4 + fs-extra: 8.1.0 + ghost-testrpc: 0.0.2 + global-modules: 2.0.0 + globby: 10.0.2 + hardhat: 2.22.10(ts-node@10.9.2(@swc/core@1.7.26)(@types/node@18.19.50)(typescript@5.6.2))(typescript@5.6.2) + jsonschema: 1.4.1 + lodash: 4.17.21 + mocha: 10.7.3 + node-emoji: 1.11.0 + pify: 4.0.1 + recursive-readdir: 2.2.3 + sc-istanbul: 0.4.6 + semver: 7.6.3 + shelljs: 0.8.5 + web3-utils: 1.10.4 + + solmate@6.2.0: {} + + source-map-js@1.2.1: {} + + source-map-support@0.5.21: + dependencies: + buffer-from: 1.1.2 + source-map: 0.6.1 + + source-map@0.2.0: + dependencies: + amdefine: 1.0.1 + optional: true + + source-map@0.5.7: {} + + source-map@0.6.1: {} + + sourcemap-codec@1.4.8: {} + + spdx-correct@3.2.0: + dependencies: + spdx-expression-parse: 3.0.1 + spdx-license-ids: 3.0.20 + + spdx-exceptions@2.5.0: {} + + spdx-expression-parse@3.0.1: + dependencies: + spdx-exceptions: 2.5.0 + spdx-license-ids: 3.0.20 + + spdx-license-ids@3.0.20: {} + + split2@3.2.2: + dependencies: + readable-stream: 3.6.2 + + sprintf-js@1.0.3: {} + + squirrelly@8.0.8: {} + + stacktrace-parser@0.1.10: + dependencies: + type-fest: 0.7.1 + + statuses@2.0.1: {} + + string-argv@0.3.2: {} + + string-format@2.0.0: {} + + string-width@2.1.1: + dependencies: + is-fullwidth-code-point: 2.0.0 + strip-ansi: 4.0.0 + + string-width@4.2.3: + dependencies: + emoji-regex: 8.0.0 + is-fullwidth-code-point: 3.0.0 + strip-ansi: 6.0.1 + + string-width@5.1.2: + dependencies: + eastasianwidth: 0.2.0 + emoji-regex: 9.2.2 + strip-ansi: 7.1.0 + + string_decoder@1.1.1: + dependencies: + safe-buffer: 5.1.2 + + string_decoder@1.3.0: + dependencies: + safe-buffer: 5.2.1 + + strip-ansi@4.0.0: + dependencies: + ansi-regex: 3.0.1 + + strip-ansi@6.0.1: + dependencies: + ansi-regex: 5.0.1 + + strip-ansi@7.1.0: + dependencies: + ansi-regex: 6.1.0 + + strip-bom@3.0.0: {} + + strip-bom@4.0.0: {} + + strip-final-newline@2.0.0: {} + + strip-final-newline@3.0.0: {} + + strip-hex-prefix@1.0.0: + dependencies: + is-hex-prefixed: 1.0.0 + + strip-indent@3.0.0: + dependencies: + min-indent: 1.0.1 + + strip-json-comments@3.1.1: {} + + supports-color@3.2.3: + dependencies: + has-flag: 1.0.0 + + supports-color@5.5.0: + dependencies: + has-flag: 3.0.0 + + supports-color@7.2.0: + dependencies: + has-flag: 4.0.0 + + supports-color@8.1.1: + dependencies: + has-flag: 4.0.0 + + supports-preserve-symlinks-flag@1.0.0: {} + + sync-request@6.1.0: + dependencies: + http-response-object: 3.0.2 + sync-rpc: 1.3.6 + then-request: 6.0.2 + + sync-rpc@1.3.6: + dependencies: + get-port: 3.2.0 + + table-layout@1.0.2: + dependencies: + array-back: 4.0.2 + deep-extend: 0.6.0 + typical: 5.2.0 + wordwrapjs: 4.0.1 + + table@6.8.2: + dependencies: + ajv: 8.17.1 + lodash.truncate: 4.4.2 + slice-ansi: 4.0.0 + string-width: 4.2.3 + strip-ansi: 6.0.1 + + tenderly@0.9.1(ts-node@10.9.2(@swc/core@1.7.26)(@types/node@18.19.50)(typescript@5.6.2))(typescript@5.6.2): + dependencies: + axios: 0.27.2 + cli-table3: 0.6.5 + commander: 9.5.0 + js-yaml: 4.1.0 + open: 8.4.2 + prompts: 2.4.2 + tslog: 4.9.3 + optionalDependencies: + ts-node: 10.9.2(@swc/core@1.7.26)(@types/node@18.19.50)(typescript@5.6.2) + typescript: 5.6.2 + transitivePeerDependencies: + - debug + + text-extensions@1.9.0: {} + + text-table@0.2.0: {} + + then-request@6.0.2: + dependencies: + '@types/concat-stream': 1.6.1 + '@types/form-data': 0.0.33 + '@types/node': 8.10.66 + '@types/qs': 6.9.15 + caseless: 0.12.0 + concat-stream: 1.6.2 + form-data: 2.5.1 + http-basic: 8.1.3 + http-response-object: 3.0.2 + promise: 8.3.0 + qs: 6.13.0 + + through2@4.0.2: + dependencies: + readable-stream: 3.6.2 + + through@2.3.8: {} + + tmp@0.0.33: + dependencies: + os-tmpdir: 1.0.2 + + to-fast-properties@2.0.0: {} + + to-regex-range@5.0.1: + dependencies: + is-number: 7.0.0 + + toidentifier@1.0.1: {} + + tr46@0.0.3: {} + + trim-newlines@3.0.1: {} + + ts-api-utils@1.3.0(typescript@5.6.2): + dependencies: + typescript: 5.6.2 + + ts-command-line-args@2.5.1: + dependencies: + chalk: 4.1.2 + command-line-args: 5.2.1 + command-line-usage: 6.1.3 + string-format: 2.0.0 + + ts-essentials@7.0.3(typescript@5.6.2): + dependencies: + typescript: 5.6.2 + + ts-node@10.9.2(@swc/core@1.7.26)(@types/node@18.19.50)(typescript@5.6.2): + dependencies: + '@cspotcode/source-map-support': 0.8.1 + '@tsconfig/node10': 1.0.11 + '@tsconfig/node12': 1.0.11 + '@tsconfig/node14': 1.0.3 + '@tsconfig/node16': 1.0.4 + '@types/node': 18.19.50 + acorn: 8.12.1 + acorn-walk: 8.3.4 + arg: 4.1.3 + create-require: 1.1.1 + diff: 4.0.2 + make-error: 1.3.6 + typescript: 5.6.2 + v8-compile-cache-lib: 3.0.1 + yn: 3.1.1 + optionalDependencies: + '@swc/core': 1.7.26 + + ts-node@10.9.2(@swc/core@1.7.26)(@types/node@20.5.1)(typescript@5.6.2): + dependencies: + '@cspotcode/source-map-support': 0.8.1 + '@tsconfig/node10': 1.0.11 + '@tsconfig/node12': 1.0.11 + '@tsconfig/node14': 1.0.3 + '@tsconfig/node16': 1.0.4 + '@types/node': 20.5.1 + acorn: 8.12.1 + acorn-walk: 8.3.4 + arg: 4.1.3 + create-require: 1.1.1 + diff: 4.0.2 + make-error: 1.3.6 + typescript: 5.6.2 + v8-compile-cache-lib: 3.0.1 + yn: 3.1.1 + optionalDependencies: + '@swc/core': 1.7.26 + + tslib@1.14.1: {} + + tslib@2.4.0: {} + + tslib@2.7.0: {} + + tslog@4.9.3: {} + + tsort@0.0.1: {} + + tweetnacl-util@0.15.1: {} + + tweetnacl@1.0.3: {} + + type-check@0.3.2: + dependencies: + prelude-ls: 1.1.2 + + type-check@0.4.0: + dependencies: + prelude-ls: 1.2.1 + + type-detect@4.1.0: {} + + type-fest@0.18.1: {} + + type-fest@0.20.2: {} + + type-fest@0.21.3: {} + + type-fest@0.6.0: {} + + type-fest@0.7.1: {} + + type-fest@0.8.1: {} + + type-fest@1.4.0: {} + + typechain@8.3.2(typescript@5.6.2): + dependencies: + '@types/prettier': 2.7.3 + debug: 4.3.7(supports-color@8.1.1) + fs-extra: 7.0.1 + glob: 7.1.7 + js-sha3: 0.8.0 + lodash: 4.17.21 + mkdirp: 1.0.4 + prettier: 2.8.8 + ts-command-line-args: 2.5.1 + ts-essentials: 7.0.3(typescript@5.6.2) + typescript: 5.6.2 + transitivePeerDependencies: + - supports-color + + typedarray@0.0.6: {} + + typescript@5.6.2: {} + + typical@4.0.0: {} + + typical@5.2.0: {} + + uglify-js@3.19.3: + optional: true + + undici-types@5.26.5: {} + + undici@5.28.4: + dependencies: + '@fastify/busboy': 2.1.1 + + undici@6.19.8: {} + + unfetch@4.2.0: {} + + universalify@0.1.2: {} + + universalify@2.0.1: {} + + unpipe@1.0.0: {} + + update-browserslist-db@1.1.0(browserslist@4.23.3): + dependencies: + browserslist: 4.23.3 + escalade: 3.2.0 + picocolors: 1.1.0 + + uri-js@4.4.1: + dependencies: + punycode: 2.3.1 + + utf8@3.0.0: {} + + util-deprecate@1.0.2: {} + + uuid@8.3.2: {} + + v8-compile-cache-lib@3.0.1: {} + + validate-npm-package-license@3.0.4: + dependencies: + spdx-correct: 3.2.0 + spdx-expression-parse: 3.0.1 + + viem@2.21.5(typescript@5.6.2): + dependencies: + '@adraffy/ens-normalize': 1.10.0 + '@noble/curves': 1.4.0 + '@noble/hashes': 1.4.0 + '@scure/bip32': 1.4.0 + '@scure/bip39': 1.4.0 + abitype: 1.0.5(typescript@5.6.2) + isows: 1.0.4(ws@8.17.1) + webauthn-p256: 0.0.5 + ws: 8.17.1 + optionalDependencies: + typescript: 5.6.2 + transitivePeerDependencies: + - bufferutil + - utf-8-validate + - zod + + wcwidth@1.0.1: + dependencies: + defaults: 1.0.4 + + web3-utils@1.10.4: + dependencies: + '@ethereumjs/util': 8.1.0 + bn.js: 5.2.1 + ethereum-bloom-filters: 1.2.0 + ethereum-cryptography: 2.2.1 + ethjs-unit: 0.1.6 + number-to-bn: 1.7.0 + randombytes: 2.1.0 + utf8: 3.0.0 + + webauthn-p256@0.0.5: + dependencies: + '@noble/curves': 1.4.0 + '@noble/hashes': 1.4.0 + + webidl-conversions@3.0.1: {} + + whatwg-url@5.0.0: + dependencies: + tr46: 0.0.3 + webidl-conversions: 3.0.1 + + which@1.3.1: + dependencies: + isexe: 2.0.0 + + which@2.0.2: + dependencies: + isexe: 2.0.0 + + widest-line@3.1.0: + dependencies: + string-width: 4.2.3 + + word-wrap@1.2.5: {} + + wordwrap@1.0.0: {} + + wordwrapjs@4.0.1: + dependencies: + reduce-flatten: 2.0.0 + typical: 5.2.0 + + workerpool@6.5.1: {} + + wrap-ansi@7.0.0: + dependencies: + ansi-styles: 4.3.0 + string-width: 4.2.3 + strip-ansi: 6.0.1 + + wrap-ansi@8.1.0: + dependencies: + ansi-styles: 6.2.1 + string-width: 5.1.2 + strip-ansi: 7.1.0 + + wrappy@1.0.2: {} + + ws@7.4.6: {} + + ws@7.5.10: {} + + ws@8.17.1: {} + + xdeployer@2.2.2(@nomicfoundation/hardhat-ethers@3.0.8(ethers@6.13.2)(hardhat@2.22.10(ts-node@10.9.2(@swc/core@1.7.26)(@types/node@18.19.50)(typescript@5.6.2))(typescript@5.6.2)))(ethers@6.13.2)(hardhat@2.22.10(ts-node@10.9.2(@swc/core@1.7.26)(@types/node@18.19.50)(typescript@5.6.2))(typescript@5.6.2)): + dependencies: + '@nomicfoundation/hardhat-ethers': 3.0.8(ethers@6.13.2)(hardhat@2.22.10(ts-node@10.9.2(@swc/core@1.7.26)(@types/node@18.19.50)(typescript@5.6.2))(typescript@5.6.2)) + ethers: 6.13.2 + hardhat: 2.22.10(ts-node@10.9.2(@swc/core@1.7.26)(@types/node@18.19.50)(typescript@5.6.2))(typescript@5.6.2) + + y18n@5.0.8: {} + + yallist@3.1.1: {} + + yallist@4.0.0: {} + + yaml@2.3.1: {} + + yargs-parser@20.2.9: {} + + yargs-parser@21.1.1: {} + + yargs-unparser@2.0.0: + dependencies: + camelcase: 6.3.0 + decamelize: 4.0.0 + flat: 5.0.2 + is-plain-obj: 2.1.0 + + yargs@16.2.0: + dependencies: + cliui: 7.0.4 + escalade: 3.2.0 + get-caller-file: 2.0.5 + require-directory: 2.1.1 + string-width: 4.2.3 + y18n: 5.0.8 + yargs-parser: 20.2.9 + + yargs@17.7.2: + dependencies: + cliui: 8.0.1 + escalade: 3.2.0 + get-caller-file: 2.0.5 + require-directory: 2.1.1 + string-width: 4.2.3 + y18n: 5.0.8 + yargs-parser: 21.1.1 + + yn@3.1.1: {} + + yocto-queue@0.1.0: {} + + zksync-web3@0.14.4(ethers@5.7.2): + dependencies: + ethers: 5.7.2 diff --git a/contracts/rollup.config.mjs b/contracts/rollup.config.mjs index 766096eb..5c3aaa3c 100644 --- a/contracts/rollup.config.mjs +++ b/contracts/rollup.config.mjs @@ -1,43 +1,37 @@ -import commonjs from "@rollup/plugin-commonjs"; -import json from "@rollup/plugin-json"; +import dts from "rollup-plugin-dts"; import { nodeResolve } from "@rollup/plugin-node-resolve"; +import json from "@rollup/plugin-json"; import autoExternal from "rollup-plugin-auto-external"; -import dts from "rollup-plugin-dts"; -import esbuild from "rollup-plugin-esbuild"; -import nodePolyfills from "rollup-plugin-node-polyfills"; +import swc from "rollup-plugin-swc3"; export default [ { - input: `build/src/index.js`, + input: `src/index.ts`, plugins: [ autoExternal(), - nodePolyfills(), json(), - commonjs(), - nodeResolve(), - esbuild({ tsconfig: "tsconfig.build.json" }), + nodeResolve({ jsnext: true, preferBuiltins: false, browser: true }), + swc(), ], output: [ { format: "esm", dir: "dist/esm", - sourcemap: true, - exports: "named", entryFileNames: "index.mjs", }, { format: "cjs", dir: "dist/cjs", - sourcemap: true, - exports: "named", + entryFileNames: "index.cjs", }, ], }, { - input: `build/src/index.d.ts`, + input: `src/index.ts`, plugins: [json(), dts()], output: { file: `dist/index.d.ts`, + format: "es", }, }, ]; diff --git a/contracts/src/deployments/deployment-marketplace-arb-sepolia.json b/contracts/src/deployments/deployment-marketplace-arb-sepolia.json new file mode 100644 index 00000000..69356a04 --- /dev/null +++ b/contracts/src/deployments/deployment-marketplace-arb-sepolia.json @@ -0,0 +1,55 @@ +{ + "TransferManager": { + "address": "0xf66abbE1c3FE57851010f2Ad5d1A78067fEDE58B", + "fullNamespace": "TransferManager", + "args": ["0x5d36971451ae593685cab8815d644f9b4b66ec99"], + "encodedArgs": "0x5d36971451ae593685cab8815d644f9b4b66ec99", + "tx": "0x42610c6d7d3766fbbaa25e76d7781865f2983c2a3d88d23540cef384f25ef017" + }, + "ProtocolFeeRecipient": { + "address": "0xf9aBC43c85808A720CFC296C5eee4516C7F429F6", + "fullNamespace": "ProtocolFeeRecipient", + "args": ["0x5d36971451AE593685Cab8815d644f9B4B66Ec99", "0x3031a6D5D9648BA5f50f656Cd4a1672E1167a34A"], + "encodedArgs": "0x5d36971451ae593685cab8815d644f9b4b66ec993031a6d5d9648ba5f50f656cd4a1672e1167a34a", + "tx": "0x859ebe02a45909d01850b479b7849ff0d40741db5d50b4a3a5c4c1314dc0434a" + }, + "HypercertExchange": { + "address": "0x1d905Bec93E48C64649300688B99D5F7d11ac412", + "fullNamespace": "LooksRareProtocol", + "args": [ + "0x5d36971451ae593685cab8815d644f9b4b66ec99", + "0xf9aBC43c85808A720CFC296C5eee4516C7F429F6", + "0xf66abbE1c3FE57851010f2Ad5d1A78067fEDE58B", + "0x3031a6D5D9648BA5f50f656Cd4a1672E1167a34A" + ], + "encodedArgs": "0x5d36971451ae593685cab8815d644f9b4b66ec99f9abc43c85808a720cfc296c5eee4516c7f429f6f66abbe1c3fe57851010f2ad5d1a78067fede58b3031a6d5d9648ba5f50f656cd4a1672e1167a34a", + "tx": "0xeec15808a49fec00f53906ef9ad71ab40521fe8fb30103293957a0ef332d8f30" + }, + "RoyaltyFeeRegistry": { + "address": "0xfCb6A37b57497E4418058BbdEfc680e2e3fe2a7f", + "fullNamespace": "RoyaltyFeeRegistry", + "args": ["1000"], + "encodedArgs": "0x00000000000000000000000000000000000000000000000000000000000003e8", + "tx": "0x48dbc49140fbdfba587ff538522b5fd904b33b89c52eebdd2a859d23e7d8564d" + }, + "OrderValidator": { + "address": "0x976427894fAE68821289f6D71388802273CAc33e", + "fullNamespace": "OrderValidatorV2A", + "args": ["0x1d905Bec93E48C64649300688B99D5F7d11ac412"], + "encodedArgs": "0x1d905bec93e48c64649300688b99d5f7d11ac412" + }, + "CreatorFeeManager": { + "address": "0xa3d5438ba3d65677d8531340da201d93e06eb5b7", + "fullNamespace": "CreatorFeeManagerWithRoyalties", + "args": ["0xfCb6A37b57497E4418058BbdEfc680e2e3fe2a7f"], + "encodedArgs": "0xfcb6a37b57497e4418058bbdefc680e2e3fe2a7f", + "tx": "0xe18a640375b419caa7d71bcee5ab5fb0681fd83142ef99c3aa4112944ce6e690" + }, + "StrategyHypercertFractionOffer": { + "address": "0x58fc599e0afd4e526a5ff69933d7a00721d28bb1", + "fullNamespace": "StrategyHypercertFractionOffer", + "args": [], + "encodedArgs": "0x", + "tx": "0xcafff6f303d32fcd7d34a6c235b573edc27a31f4c2f2e332d492b2414cae106b" + } +} diff --git a/contracts/src/deployments/deployment-marketplace-arbitrumOne.json b/contracts/src/deployments/deployment-marketplace-arbitrumOne.json new file mode 100644 index 00000000..116db5d5 --- /dev/null +++ b/contracts/src/deployments/deployment-marketplace-arbitrumOne.json @@ -0,0 +1,55 @@ +{ + "TransferManager": { + "address": "0x658c1695DCb298E57e6144F6dA3e83DdCF5e2BaB", + "fullNamespace": "TransferManager", + "args": ["0xdc6d6f9ab5fcc398b92b017e8482749ae5afbf35"], + "encodedArgs": "0xdc6d6f9ab5fcc398b92b017e8482749ae5afbf35", + "tx": "0x70b306371278c66189814b465e151006ad6a6e0c9d6b910c0234ac2ec8da1706" + }, + "ProtocolFeeRecipient": { + "address": "0xE332d4b0a30a522099292594999967267480a081", + "fullNamespace": "ProtocolFeeRecipient", + "args": ["0xE7C4531ad8828794904D332a12702beC8ff1A498", "0x82aF49447D8a07e3bd95BD0d56f35241523fBab1"], + "encodedArgs": "0xe7c4531ad8828794904d332a12702bec8ff1a49882af49447d8a07e3bd95bd0d56f35241523fbab1", + "tx": "0x6d9ff2423d04879b3445bb95c2abdfe760090391440e1e2ea92e26c267d5c696" + }, + "HypercertExchange": { + "address": "0xcE8fa09562f07c23B9C21b5d0A29a293F8a8BC83", + "fullNamespace": "LooksRareProtocol", + "args": [ + "0xdc6d6f9ab5fcc398b92b017e8482749ae5afbf35", + "0xE332d4b0a30a522099292594999967267480a081", + "0x658c1695DCb298E57e6144F6dA3e83DdCF5e2BaB", + "0x82aF49447D8a07e3bd95BD0d56f35241523fBab1" + ], + "encodedArgs": "0xdc6d6f9ab5fcc398b92b017e8482749ae5afbf35e332d4b0a30a522099292594999967267480a081658c1695dcb298e57e6144f6da3e83ddcf5e2bab82af49447d8a07e3bd95bd0d56f35241523fbab1", + "tx": "0x1eff2ebd3d6ad2a97f92c4caa648fb34fb25ca60730625d3491cd2b1171fcc23" + }, + "RoyaltyFeeRegistry": { + "address": "0xd97b92B740EAf655DFf4f93B0D6D38232cfE84C6", + "fullNamespace": "RoyaltyFeeRegistry", + "args": ["1000"], + "encodedArgs": "0x00000000000000000000000000000000000000000000000000000000000003e8", + "tx": "0x8352d52116ff97551dca27801b0fe1995e9b66ad45062021c13da4d7855f9658" + }, + "OrderValidator": { + "address": "0x74b05A917BBa5050ea216877c81801d6049b3f16", + "fullNamespace": "OrderValidatorV2A", + "args": ["0xcE8fa09562f07c23B9C21b5d0A29a293F8a8BC83"], + "encodedArgs": "0xce8fa09562f07c23b9c21b5d0a29a293f8a8bc83" + }, + "CreatorFeeManager": { + "address": "0x2d25df25ab95b74a18eb2d719a98b47f5e5f5534", + "fullNamespace": "CreatorFeeManagerWithRoyalties", + "args": ["0xd97b92B740EAf655DFf4f93B0D6D38232cfE84C6"], + "encodedArgs": "0xd97b92b740eaf655dff4f93b0d6d38232cfe84c6", + "tx": "0x2339dcf7dda93e4fbfc763a70dfe932b793552ee805c584d10acdf6127ba18f2" + }, + "StrategyHypercertFractionOffer": { + "address": "0xecab24cade0261fc6513ca13bb3d10f760af3da8", + "fullNamespace": "StrategyHypercertFractionOffer", + "args": [], + "encodedArgs": "0x", + "tx": "0x79012a15888ec5c77e7c68cbc85614645f13603e18a1f951746fa5857c0f0a23" + } +} diff --git a/contracts/src/deployments/deployment-marketplace-base-sepolia.json b/contracts/src/deployments/deployment-marketplace-base-sepolia.json new file mode 100644 index 00000000..d237adf4 --- /dev/null +++ b/contracts/src/deployments/deployment-marketplace-base-sepolia.json @@ -0,0 +1,55 @@ +{ + "TransferManager": { + "address": "0xB3B776a8AAE5BC00c74BB9b3A45Ccc27C6F471F1", + "fullNamespace": "TransferManager", + "args": ["0xdc6d6f9ab5fcc398b92b017e8482749ae5afbf35"], + "encodedArgs": "0xdc6d6f9ab5fcc398b92b017e8482749ae5afbf35", + "tx": "0x61ffc042c14063f0c04297350fb9b314559a2d661bc1a38e663639a87b33a5aa" + }, + "ProtocolFeeRecipient": { + "address": "0x25C7f07cd5461E95E48aFf54ea7D160Ed8d1E621", + "fullNamespace": "ProtocolFeeRecipient", + "args": ["0xe518aED97D9d45174a06bB8EF663B4fB51330725", "0x4200000000000000000000000000000000000006"], + "encodedArgs": "0xe518aed97d9d45174a06bb8ef663b4fb513307254200000000000000000000000000000000000006", + "tx": "0x74428db26a26f68aabcfd2397ca83d56a5a2f9aa8c6a56f34128e4a88ff88663" + }, + "HypercertExchange": { + "address": "0x5DD43eff9FCC6F70564794e997A47722fE315847", + "fullNamespace": "LooksRareProtocol", + "args": [ + "0xdc6d6f9ab5fcc398b92b017e8482749ae5afbf35", + "0x5858053C0A20Ff1cBb00bbb58FAc7A575883F628", + "0xB3B776a8AAE5BC00c74BB9b3A45Ccc27C6F471F1", + "0x7b79995e5f793A07Bc00c21412e50Ecae098E7f9" + ], + "encodedArgs": "0xdc6d6f9ab5fcc398b92b017e8482749ae5afbf355858053c0a20ff1cbb00bbb58fac7a575883f628b3b776a8aae5bc00c74bb9b3a45ccc27c6f471f17b79995e5f793a07bc00c21412e50ecae098e7f9", + "tx": "0xbf67d0d028ffbdd9afd63b5ddc457bcb22fd84470642b7120c46bb5cf4e6625f" + }, + "RoyaltyFeeRegistry": { + "address": "0x3FAe80819f084DCf27Bf5F9d5002B9246e5Ca6E0", + "fullNamespace": "RoyaltyFeeRegistry", + "args": ["1000"], + "encodedArgs": "0x00000000000000000000000000000000000000000000000000000000000003e8", + "tx": "0xa6ecc69e62415a01ae2705176676ad7ccd943e6e92e07c91d7384d948e7241ba" + }, + "OrderValidator": { + "address": "0x4F931F6954C694636b988f029b21b044aa420586", + "fullNamespace": "OrderValidatorV2A", + "args": ["0x5DD43eff9FCC6F70564794e997A47722fE315847"], + "encodedArgs": "0x5dd43eff9fcc6f70564794e997a47722fe315847" + }, + "CreatorFeeManager": { + "address": "0xe3f64e5fc801a3404129b5afa1aef08f1476d9e5", + "fullNamespace": "CreatorFeeManagerWithRoyalties", + "args": ["0x3FAe80819f084DCf27Bf5F9d5002B9246e5Ca6E0"], + "encodedArgs": "0x3fae80819f084dcf27bf5f9d5002b9246e5ca6e0", + "tx": "0xa984b0e84602f928371c5b1eaf2374c6f0623932910b114359d118f96233a240" + }, + "StrategyHypercertFractionOffer": { + "address": "0xf56ec8eebeed0b3cda7a41a57a3d8e87a17c4f43", + "fullNamespace": "StrategyHypercertFractionOffer", + "args": [], + "encodedArgs": "0x", + "tx": "0x433ead67b025cbfa98983b019ca633b56ee159cea7574411434131e6687c3e9f" + } +} diff --git a/contracts/src/deployments/deployment-marketplace-optimism-mainnet.json b/contracts/src/deployments/deployment-marketplace-optimism-mainnet.json new file mode 100644 index 00000000..5738f382 --- /dev/null +++ b/contracts/src/deployments/deployment-marketplace-optimism-mainnet.json @@ -0,0 +1,55 @@ +{ + "TransferManager": { + "address": "0x658c1695DCb298E57e6144F6dA3e83DdCF5e2BaB", + "fullNamespace": "TransferManager", + "args": ["0xdc6d6f9ab5fcc398b92b017e8482749ae5afbf35"], + "encodedArgs": "0xdc6d6f9ab5fcc398b92b017e8482749ae5afbf35", + "tx": "0x2f991683f500fafe1bbae84dd790d247195f13bf40847dca5db266ad886b607e" + }, + "ProtocolFeeRecipient": { + "address": "0x4d99FE0b683874A6FC78A9FA4Fb677AdFc460Bd0", + "fullNamespace": "ProtocolFeeRecipient", + "args": ["0xE7C4531ad8828794904D332a12702beC8ff1A498", "0x4200000000000000000000000000000000000006"], + "encodedArgs": "0xe7c4531ad8828794904d332a12702bec8ff1a4984200000000000000000000000000000000000006", + "tx": "0xbad35b553a07496fb8a9f4b5703957febc5fa6fb3f16849ca42975c5c10cfe7d" + }, + "HypercertExchange": { + "address": "0x2F7Ab1844594112E00708e18835ba2e731880Db1", + "fullNamespace": "LooksRareProtocol", + "args": [ + "0xdc6d6f9ab5fcc398b92b017e8482749ae5afbf35", + "0x4d99FE0b683874A6FC78A9FA4Fb677AdFc460Bd0", + "0x658c1695DCb298E57e6144F6dA3e83DdCF5e2BaB", + "0x4200000000000000000000000000000000000006" + ], + "encodedArgs": "0xdc6d6f9ab5fcc398b92b017e8482749ae5afbf354d99fe0b683874a6fc78a9fa4fb677adfc460bd0658c1695dcb298e57e6144f6da3e83ddcf5e2bab4200000000000000000000000000000000000006", + "tx": "0xe9f7016b0ca1d9c3c2087ecc42ee8945f120ea5aa9befb0079e023d23d8a15ec" + }, + "RoyaltyFeeRegistry": { + "address": "0xd97b92B740EAf655DFf4f93B0D6D38232cfE84C6", + "fullNamespace": "RoyaltyFeeRegistry", + "args": ["1000"], + "encodedArgs": "0x00000000000000000000000000000000000000000000000000000000000003e8", + "tx": "0x184e33f1ed0dc803a64d1be39758414382393a3797f1a18fe8eb2df1ba249034" + }, + "OrderValidator": { + "address": "0x3B51f8c645b6d1894431A11109787c8814D22C32", + "fullNamespace": "OrderValidatorV2A", + "args": ["0x2F7Ab1844594112E00708e18835ba2e731880Db1"], + "encodedArgs": "0x2f7ab1844594112e00708e18835ba2e731880db1" + }, + "CreatorFeeManager": { + "address": "0x2585159c52180f81a7a5b26acea70d398e3a72f5", + "fullNamespace": "CreatorFeeManagerWithRoyalties", + "args": ["0xd97b92B740EAf655DFf4f93B0D6D38232cfE84C6"], + "encodedArgs": "0xd97b92b740eaf655dff4f93b0d6d38232cfe84c6", + "tx": "0xe72d790b946409a94241eac77bbf6c98be2b7e0bed493842d172ab00b31e2320" + }, + "StrategyHypercertFractionOffer": { + "address": "0x9325027afcc9e86285070db2111d48005006026d", + "fullNamespace": "StrategyHypercertFractionOffer", + "args": [], + "encodedArgs": "0x", + "tx": "0x96ffab4e6d2d5e068ebeafcaf616586f545346bac25ae7c39a942f0e594ff8c0" + } +} diff --git a/contracts/src/deployments/deployment-marketplace-sepolia.json b/contracts/src/deployments/deployment-marketplace-sepolia.json index bc289e25..1f042bde 100644 --- a/contracts/src/deployments/deployment-marketplace-sepolia.json +++ b/contracts/src/deployments/deployment-marketplace-sepolia.json @@ -1,56 +1,55 @@ { "TransferManager": { - "address": "0xB4e5fFb878eA75F3Ac65fEe4C3f5552c6D30Aab9", + "address": "0x658c1695DCb298E57e6144F6dA3e83DdCF5e2BaB", "fullNamespace": "TransferManager", "args": ["0xdc6d6f9ab5fcc398b92b017e8482749ae5afbf35"], "encodedArgs": "0xdc6d6f9ab5fcc398b92b017e8482749ae5afbf35", - "tx": "0xa3d8c9e665950a006b6cb700cf09bd18a779a6359d4d0f7ffcd88f79355dbf64" + "tx": "0x9a4f5d8ab1907a603ebb87cf3e6065a7b205addf10f2ef42c8f8636b2b5ce705" }, "ProtocolFeeRecipient": { - "address": "0xB47BCab2f33c4d7805CB999888E77dD62e2600Da", + "address": "0xaDB4b94330dD29F7A7D67156b72077b918E882b4", "fullNamespace": "ProtocolFeeRecipient", "args": ["0x4f37308832c6eFE5A74737955cBa96257d76De17", "0x7b79995e5f793A07Bc00c21412e50Ecae098E7f9"], "encodedArgs": "0x4f37308832c6efe5a74737955cba96257d76de177b79995e5f793a07bc00c21412e50ecae098e7f9", - "tx": "0x9db81e96b874266392aac8cdd16451770dae7cd0ce00bef72cfe98a44d5ab6b8" + "tx": "0xfa67db564606ac9a24c0cdffa121ad3ab7e96eefb7383f23d58fbf4db592d428" }, "HypercertExchange": { - "address": "0x9819bbb6980AaA586A8e80dB963a766C6D5711c4", + "address": "0xB1991E985197d14669852Be8e53ee95A1f4621c0", "fullNamespace": "LooksRareProtocol", "args": [ "0xdc6d6f9ab5fcc398b92b017e8482749ae5afbf35", - "0xB47BCab2f33c4d7805CB999888E77dD62e2600Da", - "0xB4e5fFb878eA75F3Ac65fEe4C3f5552c6D30Aab9", + "0xaDB4b94330dD29F7A7D67156b72077b918E882b4", + "0x658c1695DCb298E57e6144F6dA3e83DdCF5e2BaB", "0x7b79995e5f793A07Bc00c21412e50Ecae098E7f9" ], - "encodedArgs": "0xdc6d6f9ab5fcc398b92b017e8482749ae5afbf35b47bcab2f33c4d7805cb999888e77dd62e2600dab4e5ffb878ea75f3ac65fee4c3f5552c6d30aab97b79995e5f793a07bc00c21412e50ecae098e7f9", - "tx": "0xb0d3b673d67b0878765957762f6b564b3686cbc18265589b19c09ab52ccf5115" + "encodedArgs": "0xdc6d6f9ab5fcc398b92b017e8482749ae5afbf35adb4b94330dd29f7a7d67156b72077b918e882b4658c1695dcb298e57e6144f6da3e83ddcf5e2bab7b79995e5f793a07bc00c21412e50ecae098e7f9", + "tx": "0x77a1f1284c83a957da90ba7daee7f6085bee34283e221727c9ccc10e8df2027a" }, "RoyaltyFeeRegistry": { - "address": "0x08FDa86868E1F058416f63e09a174467F9cC5e08", + "address": "0xd97b92B740EAf655DFf4f93B0D6D38232cfE84C6", "fullNamespace": "RoyaltyFeeRegistry", "args": ["1000"], "encodedArgs": "0x00000000000000000000000000000000000000000000000000000000000003e8", - "tx": "0x93b263e56a7a274e57ef3e6377630643617410bef42f0ba86606664423b64145" + "tx": "0x21cc81aff04ab92e986dd8e9e1fc5edd9ef7631609800e144def230a1e224129" }, "OrderValidator": { - "address": "0x1d68a6cc45e57d75b06b6f52dfc2a18d4e0452c4", + "address": "0xB7E30420a456667Aa828722E26fA64729d8DbBce", "fullNamespace": "OrderValidatorV2A", - "args": ["0x9819bbb6980AaA586A8e80dB963a766C6D5711c4"], - "encodedArgs": "0x9819bbb6980aaa586a8e80db963a766c6d5711c4", - "tx": "0x4971c131fb1d9c6118c0f46319c13da652b93e94a4eb9f8c45c85ca6ddb625ce" + "args": ["0xB1991E985197d14669852Be8e53ee95A1f4621c0"], + "encodedArgs": "0xb1991e985197d14669852be8e53ee95a1f4621c0" }, "CreatorFeeManager": { - "address": "0x9831c17f5abcfe4c0fdc2f94cdd3ad716f5ba9dd", + "address": "0xa2ce31fa3204f5ce538723b23f0418e62d54f302", "fullNamespace": "CreatorFeeManagerWithRoyalties", - "args": ["0x08FDa86868E1F058416f63e09a174467F9cC5e08"], - "encodedArgs": "0x08fda86868e1f058416f63e09a174467f9cc5e08", - "tx": "0xbf450e5a0f8a8461db6df9da6f6026aaf0aac7df370cfcb904ef692f76768d5c" + "args": ["0xd97b92B740EAf655DFf4f93B0D6D38232cfE84C6"], + "encodedArgs": "0xd97b92b740eaf655dff4f93b0d6d38232cfe84c6", + "tx": "0x5e9419057ccf80c2b561cca088f2938b0a24293ef434f1965bc56b98502a3797" }, "StrategyHypercertFractionOffer": { - "address": "0x08401da461ee03b82d86e52499fd2eddce603b81", + "address": "0x4a90ef7cc5491eb01319858cca4b1bbce64ff573", "fullNamespace": "StrategyHypercertFractionOffer", "args": [], "encodedArgs": "0x", - "tx": "0x0c0228b8328ef55df5e402e8d604ce72c6190be8c36110a6d259e2937ca85092" + "tx": "0x20561d2c5d8166cdd6cf955c6041504059df641d7b855521f838cc97d961b616" } } diff --git a/contracts/src/deployments/deployments-protocol.json b/contracts/src/deployments/deployments-protocol.json index 4d27e671..58bae742 100644 --- a/contracts/src/deployments/deployments-protocol.json +++ b/contracts/src/deployments/deployments-protocol.json @@ -5,7 +5,7 @@ }, "10": { "HypercertMinterUUPS": "0x822F17A9A5EeCFd66dBAFf7946a8071C265D1d07", - "HypercertMinterImplementation": "0x396d5f1ef3aa92ddad4dead04388374a03bc5577" + "HypercertMinterImplementation": "0xEbA30978164Cc0985091F11532C8f83a5Fa98622" }, "42220": { "HypercertMinterUUPS": "0x16bA53B74c234C870c61EFC04cD418B8f2865959", @@ -18,5 +18,13 @@ "8453": { "HypercertMinterUUPS": "0xC2d179166bc9dbB00A03686a5b17eCe2224c2704", "HypercertMinterImplementation": "0xa16DFb32Eb140a6f3F2AC68f41dAd8c7e83C4941" + }, + "421614": { + "HypercertMinterUUPS": "0x0A00a2f09cd37B24E7429c5238323bfebCfF3Ed9", + "HypercertMinterImplementation": "0x689587461AA3103D3D7975c5e4B352Ab711C14C2" + }, + "42161": { + "HypercertMinterUUPS": "0x822F17A9A5EeCFd66dBAFf7946a8071C265D1d07", + "HypercertMinterImplementation": "0xc6fbcfe16d5ebfed21ace224c49c94de49046a04" } } diff --git a/contracts/src/deployments/index.ts b/contracts/src/deployments/index.ts index c573c6eb..f924f0f3 100644 --- a/contracts/src/deployments/index.ts +++ b/contracts/src/deployments/index.ts @@ -1,7 +1,25 @@ +import deployments_marketplace_base_sepolia from "./deployment-marketplace-base-sepolia.json"; +import deployments_marketplace_optimism_mainnet from "./deployment-marketplace-optimism-mainnet.json"; import deployments_marketplace_sepolia from "./deployment-marketplace-sepolia.json"; import deployments_protocol from "./deployments-protocol.json"; +import deployments_marketplace_arb_sepolia from "./deployment-marketplace-arb-sepolia.json"; +import deployments_marketplace_arb_one from "./deployment-marketplace-arbitrumOne.json"; const deployments_marketplace = { + "10": { + TransferManager: deployments_marketplace_optimism_mainnet.TransferManager.address, + HypercertExchange: deployments_marketplace_optimism_mainnet.HypercertExchange.address, + OrderValidatorV2A: deployments_marketplace_optimism_mainnet.OrderValidator.address, + RoyaltyFeeRegistry: deployments_marketplace_optimism_mainnet.RoyaltyFeeRegistry.address, + StrategyHypercertFractionOffer: deployments_marketplace_optimism_mainnet.StrategyHypercertFractionOffer.address, + }, + "84532": { + TransferManager: deployments_marketplace_base_sepolia.TransferManager.address, + HypercertExchange: deployments_marketplace_base_sepolia.HypercertExchange.address, + OrderValidatorV2A: deployments_marketplace_base_sepolia.OrderValidator.address, + RoyaltyFeeRegistry: deployments_marketplace_base_sepolia.RoyaltyFeeRegistry.address, + StrategyHypercertFractionOffer: deployments_marketplace_base_sepolia.StrategyHypercertFractionOffer.address, + }, "11155111": { TransferManager: deployments_marketplace_sepolia.TransferManager.address, HypercertExchange: deployments_marketplace_sepolia.HypercertExchange.address, @@ -9,6 +27,20 @@ const deployments_marketplace = { RoyaltyFeeRegistry: deployments_marketplace_sepolia.RoyaltyFeeRegistry.address, StrategyHypercertFractionOffer: deployments_marketplace_sepolia.StrategyHypercertFractionOffer.address, }, + "421614": { + TransferManager: deployments_marketplace_arb_sepolia.TransferManager.address, + HypercertExchange: deployments_marketplace_arb_sepolia.HypercertExchange.address, + OrderValidatorV2A: deployments_marketplace_arb_sepolia.OrderValidator.address, + RoyaltyFeeRegistry: deployments_marketplace_arb_sepolia.RoyaltyFeeRegistry.address, + StrategyHypercertFractionOffer: deployments_marketplace_arb_sepolia.StrategyHypercertFractionOffer.address, + }, + "42161": { + TransferManager: deployments_marketplace_arb_one.TransferManager.address, + HypercertExchange: deployments_marketplace_arb_one.HypercertExchange.address, + OrderValidatorV2A: deployments_marketplace_arb_one.OrderValidator.address, + RoyaltyFeeRegistry: deployments_marketplace_arb_one.RoyaltyFeeRegistry.address, + StrategyHypercertFractionOffer: deployments_marketplace_arb_one.StrategyHypercertFractionOffer.address, + }, }; export default { marketplace: deployments_marketplace, protocol: deployments_protocol }; diff --git a/contracts/src/index.ts b/contracts/src/index.ts index 9ae6d333..30e00b8b 100644 --- a/contracts/src/index.ts +++ b/contracts/src/index.ts @@ -1,17 +1,14 @@ -import DEPLOYMENTS from "./deployments"; +import DEPLOYMENTS from "./deployments/index.js"; import HypercertMinterAbi from "../abi/src/protocol/HypercertMinter.sol/HypercertMinter.json"; import HypercertExchangeAbi from "../abi/src/marketplace/LooksRareProtocol.sol/LooksRareProtocol.json"; import OrderValidatorV2AAbi from "../abi/src/marketplace/helpers/OrderValidatorV2A.sol/OrderValidatorV2A.json"; import StrategyManagerAbi from "../abi/src/marketplace/StrategyManager.sol/StrategyManager.json"; import TransferManagerAbi from "../abi/src/marketplace/TransferManager.sol/TransferManager.json"; -import StrategyCollectionOfferAbi from "../abi/src/marketplace/executionStrategies/StrategyCollectionOffer.sol/StrategyCollectionOffer.json"; -import StrategyDutchAuctionAbi from "../abi/src/marketplace/executionStrategies/StrategyDutchAuction.sol/StrategyDutchAuction.json"; import StrategyHypercertFractionOfferAbi from "../abi/src/marketplace/executionStrategies/StrategyHypercertFractionOffer.sol/StrategyHypercertFractionOffer.json"; import CreatorFeeManagerWithRoyaltiesAbi from "../abi/src/marketplace/CreatorFeeManagerWithRoyalties.sol/CreatorFeeManagerWithRoyalties.json"; import StrategyHypercertCollectionOfferAbi from "../abi/src/marketplace/executionStrategies/StrategyHypercertCollectionOffer.sol/StrategyHypercertCollectionOffer.json"; import StrategyHypercertDutchAuctionAbi from "../abi/src/marketplace/executionStrategies/StrategyHypercertDutchAuction.sol/StrategyHypercertDutchAuction.json"; -import StrategyItemIdsRangeAbi from "../abi/src/marketplace/executionStrategies/StrategyItemIdsRange.sol/StrategyItemIdsRange.json"; import ExecutionManagerAbi from "../abi/src/marketplace/ExecutionManager.sol/ExecutionManager.json"; import { @@ -49,11 +46,11 @@ export type DeploymentMarketplace = { HypercertExchange: `0x${string}`; OrderValidatorV2A: `0x${string}`; RoyaltyFeeRegistry: `0x${string}`; - StrategyCollectionOffer: `0x${string}`; - StrategyDutchAuction: `0x${string}`; - StrategyItemIdsRange: `0x${string}`; - StrategyHypercertCollectionOffer: `0x${string}`; - StrategyHypercertDutchAuction: `0x${string}`; + // StrategyCollectionOffer: `0x${string}`; + // StrategyDutchAuction: `0x${string}`; + // StrategyItemIdsRange: `0x${string}`; + // StrategyHypercertCollectionOffer: `0x${string}`; + // StrategyHypercertDutchAuction: `0x${string}`; StrategyHypercertFractionOffer: `0x${string}`; }; @@ -64,6 +61,7 @@ export type DeployedChains = keyof typeof DEPLOYMENTS.protocol; const deployments = { 10: { ...DEPLOYMENTS.protocol["10"], + ...DEPLOYMENTS.marketplace["10"], }, 42220: { ...DEPLOYMENTS.protocol[42220], @@ -74,10 +72,19 @@ const deployments = { }, 84532: { ...DEPLOYMENTS.protocol["84532"], + ...DEPLOYMENTS.marketplace["84532"], }, 8453: { ...DEPLOYMENTS.protocol["8453"], }, + 42161: { + ...DEPLOYMENTS.protocol["42161"], + ...DEPLOYMENTS.marketplace["42161"], + }, + 421614: { + ...DEPLOYMENTS.protocol["421614"], + ...DEPLOYMENTS.marketplace["421614"], + }, } as Record; const asDeployedChain = (chainId: string | number) => { @@ -96,9 +103,6 @@ export { OrderValidatorV2AAbi, TransferManagerAbi, StrategyManagerAbi, - StrategyCollectionOfferAbi, - StrategyDutchAuctionAbi, - StrategyItemIdsRangeAbi, StrategyHypercertFractionOfferAbi, StrategyHypercertCollectionOfferAbi, StrategyHypercertDutchAuctionAbi, diff --git a/contracts/tasks/config.ts b/contracts/tasks/config.ts new file mode 100644 index 00000000..4915724d --- /dev/null +++ b/contracts/tasks/config.ts @@ -0,0 +1,86 @@ +export type TokenAddressType = { sepolia: string; [key: string]: string }; + +const WETH: TokenAddressType = { + localhost: "0x7b79995e5f793A07Bc00c21412e50Ecae098E7f9", //dummy + hardhat: "0x7b79995e5f793A07Bc00c21412e50Ecae098E7f9", //dummy + sepolia: "0x7b79995e5f793A07Bc00c21412e50Ecae098E7f9", + "optimism-mainnet": "0x4200000000000000000000000000000000000006", + "base-sepolia": "0x4200000000000000000000000000000000000006", + "arb-sepolia": "0x3031a6D5D9648BA5f50f656Cd4a1672E1167a34A", + arbitrumOne: "0x82aF49447D8a07e3bd95BD0d56f35241523fBab1", +}; + +// LINK faucet for Sepolia: https://faucets.chain.link/ +const DAI: TokenAddressType = { + localhost: "0x779877A7B0D9E8603169DdbD7836e478b4624789", + hardhat: "0x779877A7B0D9E8603169DdbD7836e478b4624789", + sepolia: "0x779877A7B0D9E8603169DdbD7836e478b4624789", + "optimism-mainnet": "0xda10009cbd5d07dd0cecc66161fc93d7c9000da1", + "base-sepolia": "0xE4aB69C077896252FAFBD49EFD26B5D171A32410", + "arb-sepolia": "0xb1D4538B4571d411F07960EF2838Ce337FE1E80E", + arbitrumOne: "0xDA10009cBd5D07dd0CeCc66161FC93D7c9000da1", +}; + +// USDC https://faucet.circle.com/ +// https://developers.circle.com/stablecoins/docs/usdc-on-main-networks +const USDC: TokenAddressType = { + localhost: "0x1c7D4B196Cb0C7B01d743Fbc6116a902379C7238", + hardhat: "0x1c7D4B196Cb0C7B01d743Fbc6116a902379C7238", + sepolia: "0x1c7D4B196Cb0C7B01d743Fbc6116a902379C7238", + "optimism-mainnet": "0x0b2C639c533813f4Aa9D7837CAf62653d097Ff85", + "base-sepolia": "0x036CbD53842c5426634e7929541eC2318f3dCF7e", + "arb-sepolia": "0x75faf114eafb1BDbe2F0316DF893fd58CE46AA4d", + arbitrumOne: "0xaf88d065e77c8cC2239327C5EDb3A432268e5831", +}; + +export const getTokenAddresses = (network: string) => { + return { + wethAddress: WETH[network], + usdceAddress: USDC[network], + daiAddress: DAI[network], + }; +}; + +const ADMIN_ACCOUNT: { [key: string]: string } = { + localhost: "0x4f37308832c6eFE5A74737955cBa96257d76De17", + hardhat: "0x4f37308832c6eFE5A74737955cBa96257d76De17", + sepolia: "0x4f37308832c6eFE5A74737955cBa96257d76De17", + "base-sepolia": "0xA2Cb9D926b090577AD45fC0F40C753BF369B82Ff", + "optimism-mainnet": "0x560adA72a80b4707e493cA8c3B7B7528930E7Be5", + celo: "0x14ae502FEF3843fF3a1735B3209D39B320130af9", + base: "0x14ae502FEF3843fF3a1735B3209D39B320130af9", + arbitrumOne: "0x14ae502FEF3843fF3a1735B3209D39B320130af9", + "arb-sepolia": "0x5d36971451AE593685Cab8815d644f9B4B66Ec99", +}; + +export const getAdminAccount = (network: string): string => { + const account = ADMIN_ACCOUNT[network]; + + if (!account || account === null || account.trim() === "") { + throw new Error(`Admin account for network "${network}" is not defined, null, or empty.`); + } + + return account; +}; + +const FEE_RECIPIENT: { [key: string]: string } = { + localhost: "0x4f37308832c6eFE5A74737955cBa96257d76De17", + hardhat: "0x4f37308832c6eFE5A74737955cBa96257d76De17", + sepolia: "0x4f37308832c6eFE5A74737955cBa96257d76De17", + "base-sepolia": "0xe518aED97D9d45174a06bB8EF663B4fB51330725", + "optimism-mainnet": "0xE7C4531ad8828794904D332a12702beC8ff1A498", + celo: "0xE7C4531ad8828794904D332a12702beC8ff1A498", + base: "0xE7C4531ad8828794904D332a12702beC8ff1A498", + arbitrumOne: "0xE7C4531ad8828794904D332a12702beC8ff1A498", + "arb-sepolia": "0x5d36971451AE593685Cab8815d644f9B4B66Ec99", +}; + +export const getFeeRecipient = (network: string): string => { + const recipient = FEE_RECIPIENT[network]; + + if (!recipient || recipient === null || recipient.trim() === "") { + throw new Error(`Fee recipient for network "${network}" is not defined, null, or empty.`); + } + + return recipient; +}; diff --git a/contracts/tasks/deploy-fee-recipient.ts b/contracts/tasks/deploy-fee-recipient.ts new file mode 100644 index 00000000..75bff887 --- /dev/null +++ b/contracts/tasks/deploy-fee-recipient.ts @@ -0,0 +1,190 @@ +import { task } from "hardhat/config"; +import { solidityPacked } from "ethers"; +import { + getContractAddress, + slice, + encodeDeployData, + getContract, + WalletClient, + encodePacked, + PublicClient, +} from "viem"; +import { writeFile } from "node:fs/promises"; +import { getAdminAccount, getFeeRecipient, getTokenAddresses } from "./config"; + +function sleep(ms) { + return new Promise((resolve) => setTimeout(resolve, ms)); +} + +const getCreate2Address = async ( + deployer: WalletClient, + factory: `0x${string}`, + bytecode: `0x${string}`, + salt: `0x${string}`, +) => { + if (!deployer.account?.address) { + throw new Error("Deployer account is undefined"); + } + + const address = getContractAddress({ + from: factory, + salt, + opcode: "CREATE2", + bytecode, + }); + return { address, salt, deployData: bytecode }; +}; + +const runCreate2Deployment = async ( + publicClient: PublicClient, + create2Instance: ReturnType, + contractName: string, + create2: { + address: `0x${string}`; + salt: `0x${string}`; + deployData: `0x${string}`; + }, + args: string[], +) => { + console.log(`deploying ${contractName} with args: ${args}`); + const { request } = await publicClient.simulateContract({ + address: create2Instance.address, + abi: create2Instance.abi, + functionName: "safeCreate2", + args: [create2.salt, create2.deployData], + account: "0xdc6d6f9ab5fcc398b92b017e8482749ae5afbf35", + }); + + const hash = await create2Instance.write.safeCreate2([create2.salt, create2.deployData]); + const deployTx = await publicClient.waitForTransactionReceipt({ + hash, + }); + + console.log( + deployTx.status === "success" ? `Deployed ${contractName} successfully` : `Failed to deploy ${contractName}`, + ); + + return hash; +}; + +interface ContractDeployment { + address: string; + fullNamespace: string; + args: string[]; + encodedArgs: string; + tx: `0x${string}`; +} + +type ContractDeployments = { + [name: string]: ContractDeployment; +}; + +task("deploy-fee-recipient", "Deploy marketplace fee recipient and verify") + .addOptionalParam("output", "write the details of the deployment to this file if this is set") + .setAction(async ({ output }, hre) => { + //TODO multichain support + const { ethers, network, run, viem } = hre; + const create2Address = "0x0000000000ffe8b47b3e2130213b802212439497"; + const { wethAddress, usdceAddress, daiAddress } = getTokenAddresses(network.name); + + const publicClient = await viem.getPublicClient(); + const [deployer] = await viem.getWalletClients(); + const create2Instance = await viem.getContractAt("IImmutableCreate2Factory", create2Address, { + walletClient: deployer, + }); + + console.log("Deployer: ", deployer.account.address); + + const releaseVersion = "v1.0.2"; + + const salt = slice( + encodePacked(["address", "string", "address"], [deployer.account?.address, releaseVersion, create2Address]), + 0, + 32, + ); + console.log("Calculated salt: ", salt); + + const contracts: ContractDeployments = {}; + + const protocolFeeRecipientContract = await hre.artifacts.readArtifact("ProtocolFeeRecipient"); + + // Create2 ProtocolFeeRecipient + const protocolFeeRecipientArgs = [getFeeRecipient(network.name), wethAddress]; + console.log("ProtocolFeeRecipient args: ", protocolFeeRecipientArgs); + const protocolFeeRecipientCreate2 = await getCreate2Address( + deployer, + create2Address, + encodeDeployData({ + abi: protocolFeeRecipientContract.abi, + bytecode: protocolFeeRecipientContract.bytecode as `0x${string}`, + args: protocolFeeRecipientArgs, + }), + salt, + ); + + // Deploy ProtocolFeeRecipient + const protocolFeeRecipientTx = await runCreate2Deployment( + publicClient, + create2Instance, + "ProtocolFeeRecipient", + protocolFeeRecipientCreate2, + protocolFeeRecipientArgs, + ); + + // Add to deployed contracts object + contracts.ProtocolFeeRecipient = { + address: protocolFeeRecipientCreate2.address, + fullNamespace: "ProtocolFeeRecipient", + args: protocolFeeRecipientArgs, + encodedArgs: solidityPacked(["address", "address"], protocolFeeRecipientArgs), + tx: protocolFeeRecipientTx, + }; + + await sleep(2000); + + console.log("🚀 Done!"); + + // Validate + if (network.name !== "hardhat" && network.name !== "localhost") { + // Write deployment details to file + console.log("Writing deployment details to file. Make sure to update the marketplace deployment file"); + await writeFile( + `src/deployments/deployment-fee-recipeint-${network.name}.json`, + JSON.stringify(contracts), + "utf-8", + ); + + // Verify contracts + console.log("Verifying contracts..."); + for (const [name, { address, tx, args }] of Object.entries(contracts)) { + try { + console.log(`Verifying ${name}...`); + + const code = await publicClient.getBytecode({ address: address as `0x${string}` }); + if (code === "0x") { + console.log(`${name} contract deployment has not completed. waiting to verify...`); + const receipt = await publicClient.waitForTransactionReceipt({ + hash: tx, + }); + + await run("verify:verify", { + address: receipt.contractAddress, + constructorArguments: args, + }); + } else { + await run("verify:verify", { + address, + constructorArguments: args, + }); + } + } catch (error) { + const errorMessage = (error as Error).message; + + if (errorMessage.includes("Reason: Already Verified")) { + console.log("Reason: Already Verified"); + } + console.error(errorMessage); + } + } + } + }); diff --git a/contracts/tasks/deploy-marketplace.ts b/contracts/tasks/deploy-marketplace.ts index da8a71f9..02998862 100644 --- a/contracts/tasks/deploy-marketplace.ts +++ b/contracts/tasks/deploy-marketplace.ts @@ -10,43 +10,11 @@ import { PublicClient, } from "viem"; import { writeFile } from "node:fs/promises"; +import { getAdminAccount, getFeeRecipient, getTokenAddresses } from "./config"; -type TokenAddressType = { sepolia: string; [key: string]: string }; - -const WETH: TokenAddressType = { - localhost: "0x7b79995e5f793A07Bc00c21412e50Ecae098E7f9", //dummy - hardhat: "0x7b79995e5f793A07Bc00c21412e50Ecae098E7f9", //dummy - sepolia: "0x7b79995e5f793A07Bc00c21412e50Ecae098E7f9", -}; - -// LINK faucet: https://faucets.chain.link/ -const DAI: TokenAddressType = { - localhost: "0x779877A7B0D9E8603169DdbD7836e478b4624789", - hardhat: "0x779877A7B0D9E8603169DdbD7836e478b4624789", - sepolia: "0x779877A7B0D9E8603169DdbD7836e478b4624789", -}; - -// USDCe https://faucet.circle.com/ -const USDCe: TokenAddressType = { - localhost: "0x1c7D4B196Cb0C7B01d743Fbc6116a902379C7238", - hardhat: "0x1c7D4B196Cb0C7B01d743Fbc6116a902379C7238", - sepolia: "0x1c7D4B196Cb0C7B01d743Fbc6116a902379C7238", -}; - -const USDT: TokenAddressType = { - localhost: "0x1c7D4B196Cb0C7B01d743Fbc6116a902379C7238", - hardhat: "0x1c7D4B196Cb0C7B01d743Fbc6116a902379C7238", - sepolia: "0x1c7D4B196Cb0C7B01d743Fbc6116a902379C7238", -}; - -const getTokenAddresses = (network: string) => { - return { - wethAddress: WETH[network], - usdceAddress: USDCe[network], - daiAddress: DAI[network], - usdtAddress: USDT[network], - }; -}; +function sleep(ms) { + return new Promise((resolve) => setTimeout(resolve, ms)); +} const getCreate2Address = async ( deployer: WalletClient, @@ -79,6 +47,14 @@ const runCreate2Deployment = async ( args: string[], ) => { console.log(`deploying ${contractName} with args: ${args}`); + const { request } = await publicClient.simulateContract({ + address: create2Instance.address, + abi: create2Instance.abi, + functionName: "safeCreate2", + args: [create2.salt, create2.deployData], + account: "0xDc6d6f9aB5fcc398B92B017e8482749aE5afbF35", // update method to take account as arg + }); + const hash = await create2Instance.write.safeCreate2([create2.salt, create2.deployData]); const deployTx = await publicClient.waitForTransactionReceipt({ hash, @@ -109,7 +85,7 @@ task("deploy-marketplace", "Deploy marketplace contracts and verify") //TODO multichain support const { ethers, network, run, viem } = hre; const create2Address = "0x0000000000ffe8b47b3e2130213b802212439497"; - const { wethAddress, usdceAddress, daiAddress, usdtAddress } = getTokenAddresses(network.name); + const { wethAddress, usdceAddress, daiAddress } = getTokenAddresses(network.name); const publicClient = await viem.getPublicClient(); const [deployer] = await viem.getWalletClients(); @@ -121,19 +97,24 @@ task("deploy-marketplace", "Deploy marketplace contracts and verify") // 10_000 = 100% // Sepolia admin Safe = sep:0x4f37308832c6eFE5A74737955cBa96257d76De17 + + /** + * DEPLOYMENT CONFIGURATION + */ + const marketplaceParameters = { - owner: "0x4f37308832c6eFE5A74737955cBa96257d76De17", // hc admin safe - protocolFeeRecipient: "0x4f37308832c6eFE5A74737955cBa96257d76De17", // hc fee safe + owner: getAdminAccount(network.name), // hc admin safe + protocolFeeRecipient: getFeeRecipient(network.name), // hc fee safe standardProtocolFeeBP: 100, minTotalFeeBp: 100, maxProtocolFeeBp: 200, royaltyFeeLimit: "1000", }; - const releaseCounter = "v0.9"; + const releaseVersion = "v1.0.1"; const salt = slice( - encodePacked(["address", "string", "address"], [deployer.account?.address, releaseCounter, create2Address]), + encodePacked(["address", "string", "address"], [deployer.account?.address, releaseVersion, create2Address]), 0, 32, ); @@ -149,53 +130,7 @@ task("deploy-marketplace", "Deploy marketplace contracts and verify") const protocolFeeRecipientContract = await hre.artifacts.readArtifact("ProtocolFeeRecipient"); const royaltyFeeRegistryContract = await hre.artifacts.readArtifact("RoyaltyFeeRegistry"); - // const strategyCollectionOfferContract = await hre.artifacts.readArtifact("StrategyCollectionOffer"); - // const strategyDutchAuctionContract = await hre.artifacts.readArtifact("StrategyDutchAuction"); - // const strategyItemIdsRangeContract = await hre.artifacts.readArtifact("StrategyItemIdsRange"); - // const strategyHypercertCollectionOfferContract = await hre.artifacts.readArtifact( - // "StrategyHypercertCollectionOffer", - // ); - // const strategyHypercertDutchAuctionContract = await hre.artifacts.readArtifact("StrategyHypercertDutchAuction"); - const strategies = [ - // { - // contract: strategyCollectionOfferContract, - // name: "StrategyCollectionOffer", - // isMakerBid: true, - // strategies: [ - // "executeCollectionStrategyWithTakerAsk", - // "executeCollectionStrategyWithTakerAskWithProof", - // "executeCollectionStrategyWithTakerAskWithAllowlist", - // ], - // }, - // { - // contract: strategyDutchAuctionContract, - // name: "StrategyDutchAuction", - // isMakerBid: false, - // strategies: ["executeStrategyWithTakerBid"], - // }, - // { - // contract: strategyItemIdsRangeContract, - // name: "StrategyItemIdsRange", - // isMakerBid: true, - // strategies: ["executeStrategyWithTakerAsk"], - // }, - // { - // contract: strategyHypercertCollectionOfferContract, - // name: "StrategyHypercertCollectionOffer", - // isMakerBid: true, - // strategies: [ - // "executeHypercertCollectionStrategyWithTakerAsk", - // "executeHypercertCollectionStrategyWithTakerAskWithProof", - // "executeHypercertCollectionStrategyWithTakerAskWithAllowlist", - // ], - // }, - // { - // contract: strategyHypercertDutchAuctionContract, - // name: "StrategyHypercertDutchAuction", - // isMakerBid: false, - // strategies: ["executeStrategyWithTakerBid"], - // }, { contract: strategyHypercertFractionOfferContract, name: "StrategyHypercertFractionOffer", @@ -208,7 +143,8 @@ task("deploy-marketplace", "Deploy marketplace contracts and verify") ]; // Create2 Transfermanager - const transferManagerArgs = [deployer.account?.address]; // initial owner is deployer + const transferManagerArgs = [deployer.account.address]; // initial owner is deployer + console.log("TransferManager args: ", transferManagerArgs); const transferManagerCreate2 = await getCreate2Address( deployer, create2Address, @@ -222,6 +158,7 @@ task("deploy-marketplace", "Deploy marketplace contracts and verify") // Create2 ProtocolFeeRecipient const protocolFeeRecipientArgs = [marketplaceParameters.protocolFeeRecipient, wethAddress]; + console.log("ProtocolFeeRecipient args: ", protocolFeeRecipientArgs); const protocolFeeRecipientCreate2 = await getCreate2Address( deployer, create2Address, @@ -241,6 +178,8 @@ task("deploy-marketplace", "Deploy marketplace contracts and verify") wethAddress, ]; + console.log("HypercertsExchange args: ", hypercertsExchangeArgs); + const hypercertsExchangeCreate2 = await getCreate2Address( deployer, create2Address, @@ -255,6 +194,8 @@ task("deploy-marketplace", "Deploy marketplace contracts and verify") // Create2 RoyaltyFeeManager const royaltyFeeRegistryArgs = [marketplaceParameters.royaltyFeeLimit]; + console.log("RoyaltyFeeRegistry args: ", royaltyFeeRegistryArgs); + const royaltyFeeRegistryCreate2 = await getCreate2Address( deployer, create2Address, @@ -294,6 +235,10 @@ task("deploy-marketplace", "Deploy marketplace contracts and verify") value: 1n, }); + console.log("deposited 1 wei in exchange"); + + await sleep(2000); + // Deploy ProtocolFeeRecipient const protocolFeeRecipientTx = await runCreate2Deployment( publicClient, @@ -311,6 +256,8 @@ task("deploy-marketplace", "Deploy marketplace contracts and verify") tx: protocolFeeRecipientTx, }; + await sleep(2000); + // Deploy HypercertsExchange const hypercertsExchangeTx = await runCreate2Deployment( publicClient, @@ -328,6 +275,8 @@ task("deploy-marketplace", "Deploy marketplace contracts and verify") tx: hypercertsExchangeTx, }; + await sleep(2000); + // Deploy RoyaltyFeeRegistry const royaltyFeeRegistryTx = await runCreate2Deployment( publicClient, @@ -345,28 +294,41 @@ task("deploy-marketplace", "Deploy marketplace contracts and verify") tx: royaltyFeeRegistryTx, }; + await sleep(2000); + // Allow Exchange as operator on transferManager const transferManagerInstance = getContract({ address: transferManagerCreate2.address, abi: transferManagerContract.abi, - publicClient, - walletClient: deployer, + client: { public: publicClient, wallet: deployer }, }); // Deploy OrderValidator const orderValidatorArgs = [hypercertsExchangeCreate2.address]; - const deployOrderValidator = await deployer.deployContract({ - abi: orderValidatorContract.abi, - account: deployer.account, - args: orderValidatorArgs, - bytecode: orderValidatorContract.bytecode as `0x${string}`, - }); + console.log("OrderValidator args: ", orderValidatorArgs); - const orderValidatorTx = await publicClient.waitForTransactionReceipt({ - hash: deployOrderValidator, - }); + const orderValidatorCreate2 = await getCreate2Address( + deployer, + create2Address, + encodeDeployData({ + abi: orderValidatorContract.abi, + bytecode: orderValidatorContract.bytecode as `0x${string}`, + args: orderValidatorArgs, + }), + salt, + ); + + await sleep(2000); + + const orderValidatorTx = await runCreate2Deployment( + publicClient, + create2Instance, + "OrderValidatorV2A", + orderValidatorCreate2, + orderValidatorArgs, + ); console.log( orderValidatorTx.status === "success" @@ -375,7 +337,7 @@ task("deploy-marketplace", "Deploy marketplace contracts and verify") ); contracts.OrderValidator = { - address: orderValidatorTx.contractAddress, + address: orderValidatorCreate2.address, fullNamespace: "OrderValidatorV2A", args: orderValidatorArgs, encodedArgs: solidityPacked(["address"], orderValidatorArgs), @@ -384,7 +346,11 @@ task("deploy-marketplace", "Deploy marketplace contracts and verify") // Deploy CreatorFeeManager + await sleep(2000); + const creatorFeeManagerArgs = [royaltyFeeRegistryCreate2.address]; + + console.log("CreatorFeeManager args: ", creatorFeeManagerArgs); const deployCreatorFeeManager = await deployer.deployContract({ abi: creatorFeeManagerContract.abi, account: deployer.account, @@ -415,36 +381,27 @@ task("deploy-marketplace", "Deploy marketplace contracts and verify") const hypercertsExchangeInstance = getContract({ address: hypercertsExchangeCreate2.address, abi: exchangeContract.abi, - publicClient, - walletClient: deployer, + client: { public: publicClient, wallet: deployer }, }); - // read transferManager from HypercertsExchange - const transferManager = await hypercertsExchangeInstance.read.transferManager(); - console.log("TransferManager address: ", transferManager); - - // read deriveProtocolParams from HypercertsExchange - const domainSeparator = await hypercertsExchangeInstance.read.domainSeparator(); - console.log("domainSeparator: ", domainSeparator); - - const creatorFeeManager = await hypercertsExchangeInstance.read.creatorFeeManager(); - console.log("creatorFeeManager: ", creatorFeeManager); - - const maxCreatorFeeBp = await hypercertsExchangeInstance.read.maxCreatorFeeBp(); - console.log("maxCreatorFeeBp: ", maxCreatorFeeBp); + await sleep(2000); // Update currency status for accepted tokens - await allowCurrency("0x0000000000000000000000000000000000000000", "ETH"); + await allowCurrency("0x0000000000000000000000000000000000000000", "native"); await allowCurrency(wethAddress, "WETH"); - await allowCurrency(usdceAddress, "USDCe"); + await allowCurrency(usdceAddress, "USDC"); await allowCurrency(daiAddress, "DAI"); - await allowCurrency(usdtAddress, "USDT"); - // Update creatorFeeManager address + // Update creatorFeeManager address' + + await sleep(2000); + const updateCreatorFeeManager = await hypercertsExchangeInstance.write.updateCreatorFeeManager([ creatorFeeManagerTx.contractAddress, ]); + await sleep(2000); + const updateCreatorFeeManagerTx = await publicClient.waitForTransactionReceipt({ hash: updateCreatorFeeManager, }); @@ -457,10 +414,28 @@ task("deploy-marketplace", "Deploy marketplace contracts and verify") // DEPLOYING STRATEGIES + await sleep(2000); + console.log("Deploying and adding strategies...."); await addStrategiesToExchange(strategies, marketplaceParameters); + console.log("Creating proposal for new owner..."); + + const ownershipTransferTx = await hypercertsExchangeInstance.write.initiateOwnershipTransfer([ + marketplaceParameters.owner, + ]); + + const ownershipTransferReceipt = await publicClient.waitForTransactionReceipt({ + hash: ownershipTransferTx, + }); + + console.log( + ownershipTransferReceipt.status === "success" + ? "Ownership transfer initiated successfully" + : "Failed to initiate ownership transfer", + ); + console.log("🚀 Done!"); // Validate @@ -562,6 +537,8 @@ task("deploy-marketplace", "Deploy marketplace contracts and verify") ? `Added strategy ${strat} to exchange successfully` : `Failed to add ${strat}`, ); + + await sleep(2000); } contracts[strategy.name] = { @@ -574,7 +551,7 @@ task("deploy-marketplace", "Deploy marketplace contracts and verify") } } - async function allowCurrency(tokenAddress: string, name: string) { + async function allowCurrency(tokenAddress: string, name?: string) { const hash = await hypercertsExchangeInstance.write.updateCurrencyStatus([tokenAddress, true]); const receipt = await publicClient.waitForTransactionReceipt({ hash, @@ -585,5 +562,7 @@ task("deploy-marketplace", "Deploy marketplace contracts and verify") ? `Updated currency status for ${tokenAddress} (${name}) successfully` : `Failed to update currency status for ${tokenAddress} (${name})`, ); + + await sleep(2000); } }); diff --git a/contracts/tasks/deploy-propose-upgrade.ts b/contracts/tasks/deploy-propose-upgrade.ts new file mode 100644 index 00000000..0e9327e8 --- /dev/null +++ b/contracts/tasks/deploy-propose-upgrade.ts @@ -0,0 +1,52 @@ +import { task } from "hardhat/config"; + +task("deploy-propose-upgrade", "Validate, deploy and verify an upgraded implementation") + .addParam("proxy", "Provider current proxy address") + .setAction(async ({ proxy }, { ethers, upgrades, network, run }) => { + console.log("network: ", network); + console.log("Using address: ", await ethers.getSigners().then((res) => res[0].address)); + const HypercertMinter = await ethers.getContractFactory("HypercertMinter"); + + console.log("Validating implementation.."); + await upgrades + .validateImplementation(HypercertMinter, { kind: "uups" }) + .then(() => console.log("Valid implementation")); + + console.log("Preparing upgrade.."); + const newImplementationAddress = await upgrades + .prepareUpgrade(proxy, HypercertMinter, { + useDefenderDeploy: false, + redeployImplementation: "always", + kind: "uups", + }) + .then((res) => { + return res; + }); + + console.log(`Deployed upgraded contract to ${newImplementationAddress}`); + + if (network.name !== "hardhat" && network.name !== "localhost") { + console.log(`Starting verification process...`); + + try { + const code = await ethers.provider.getCode(newImplementationAddress); + if (code === "0x") { + console.log(`Contract deployment has not completed. waiting to verify...`); + await HypercertMinter.attach(newImplementationAddress).deployed(); + } + + await run("verify:verify", { + address: newImplementationAddress, + }); + } catch (error) { + const errorMessage = (error as Error).message; + + if (errorMessage.includes("Reason: Already Verified")) { + console.log("Reason: Already Verified"); + } + console.error(errorMessage); + } + } + + console.log(`Done 🚀`); + }); diff --git a/contracts/tasks/force-import.ts b/contracts/tasks/force-import.ts index 9c919855..bd03fe38 100644 --- a/contracts/tasks/force-import.ts +++ b/contracts/tasks/force-import.ts @@ -7,5 +7,6 @@ task("force-import", "Deploy contracts and verify") const hypercertMinter = await upgrades.forceImport(proxy, HypercertMinter, { kind: "uups", }); - console.log(`HypercertMinter imported: ${hypercertMinter.address}`); + console.log(`HypercertMinter imported: ${hypercertMinter}`); + console.log(Object.keys(hypercertMinter)); }); diff --git a/contracts/tasks/index.ts b/contracts/tasks/index.ts index f76abd26..9b31a4b3 100644 --- a/contracts/tasks/index.ts +++ b/contracts/tasks/index.ts @@ -1,13 +1,15 @@ -export * from "./deploy-minter"; -export * from "./deploy-implementation"; -export * from "./force-import"; -export * from "./generate-address"; -export * from "./pause"; -export * from "./transfer-owner"; -export * from "./transfer-from-test-account"; -export * from "./test-tx-client"; -export * from "./upgrade"; -export * from "./unpause"; -export * from "./validate-upgrade"; -export * from "./deploy-marketplace"; -export * from "./propose-owner"; +export * from "./deploy-minter.js"; +export * from "./deploy-implementation.js"; +export * from "./force-import.js"; +export * from "./generate-address.js"; +export * from "./pause.js"; +export * from "./transfer-owner.js"; +export * from "./transfer-from-test-account.js"; +export * from "./test-tx-client.js"; +export * from "./upgrade.js"; +export * from "./unpause.js"; +export * from "./validate-upgrade.js"; +export * from "./deploy-marketplace.js"; +export * from "./propose-owner.js"; +export * from "./deploy-fee-recipient.js"; +export * from "./deploy-propose-upgrade.js"; diff --git a/contracts/tsconfig.build.json b/contracts/tsconfig.build.json index e9929279..ee3bb128 100644 --- a/contracts/tsconfig.build.json +++ b/contracts/tsconfig.build.json @@ -3,36 +3,23 @@ "baseUrl": ".", "allowSyntheticDefaultImports": true, "declaration": true, - "declarationMap": true, "emitDecoratorMetadata": true, "esModuleInterop": true, "experimentalDecorators": true, "forceConsistentCasingInFileNames": true, "lib": ["es6"], - "module": "ESNext", - "moduleResolution": "node", + "module": "Node16", "noImplicitAny": true, "noImplicitOverride": false, "removeComments": true, "resolveJsonModule": true, - "sourceMap": true, "strict": true, - "target": "ESNext", + "target": "ES2022", "outDir": "build" }, - "include": ["./src"], - "files": [ - "types/src/marketplace/CurrencyManager.ts", - "types/src/marketplace/ExecutionManager.ts", - "types/src/marketplace/LooksRareProtocol.ts", - "types/src/marketplace/NonceManager.ts", - "types/src/marketplace/helpers/OrderValidatorV2A.ts", - "types/src/marketplace/StrategyManager.ts", - "types/src/marketplace/TransferManager.ts", - "types/src/protocol/AllowlistMinter.ts", - "types/src/protocol/HypercertMinter.ts", - "types/src/protocol/interfaces/IAllowlist.ts", - "types/src/protocol/interfaces/IHypercertToken.ts", - "types/src/protocol/libs/Errors.ts" - ] + "include": ["./src", "./types"], + "ts-node": { + "experimentalResolver": true, + "files": true + } } diff --git a/contracts/tsconfig.json b/contracts/tsconfig.json index a3e3d8dc..638bfc4e 100644 --- a/contracts/tsconfig.json +++ b/contracts/tsconfig.json @@ -3,36 +3,23 @@ "baseUrl": ".", "allowSyntheticDefaultImports": true, "declaration": true, - "declarationMap": true, "emitDecoratorMetadata": true, "esModuleInterop": true, "experimentalDecorators": true, "forceConsistentCasingInFileNames": true, "lib": ["es6"], - "module": "CommonJS", - "moduleResolution": "node", + "module": "Node16", "noImplicitAny": true, "noImplicitOverride": false, "removeComments": true, "resolveJsonModule": true, - "sourceMap": true, "strict": true, - "target": "ESNext", + "target": "ES2022", "outDir": "dist" }, - "include": ["./tasks", "./test", "./src"], - "files": [ - "types/src/marketplace/CurrencyManager.ts", - "types/src/marketplace/ExecutionManager.ts", - "types/src/marketplace/LooksRareProtocol.ts", - "types/src/marketplace/NonceManager.ts", - "types/src/marketplace/helpers/OrderValidatorV2A.ts", - "types/src/marketplace/StrategyManager.ts", - "types/src/marketplace/TransferManager.ts", - "types/src/protocol/AllowlistMinter.ts", - "types/src/protocol/HypercertMinter.ts", - "types/src/protocol/interfaces/IAllowlist.ts", - "types/src/protocol/interfaces/IHypercertToken.ts", - "types/src/protocol/libs/Errors.ts" - ] + "include": ["./tasks", "./test", "./src", "./hardhat.config.cjs", "./types"], + "ts-node": { + "experimentalResolver": true, + "files": true + } } diff --git a/cors-proxy/.eslintrc.json b/cors-proxy/.eslintrc.json deleted file mode 100644 index c4d08aab..00000000 --- a/cors-proxy/.eslintrc.json +++ /dev/null @@ -1,24 +0,0 @@ -{ - "env": { - "es2021": true, - "node": true - }, - "extends": [ - "eslint:recommended", - "plugin:@typescript-eslint/recommended", - "prettier" - ], - "parser": "@typescript-eslint/parser", - "parserOptions": { - "ecmaFeatures": { - "jsx": true - }, - "ecmaVersion": "latest", - "sourceType": "module" - }, - "plugins": ["@typescript-eslint"], - "rules": { - "@typescript-eslint/no-explicit-any": "off", - "@typescript-eslint/no-unused-vars": ["warn", { "argsIgnorePattern": "^_" }] - } -} diff --git a/cors-proxy/package.json b/cors-proxy/package.json deleted file mode 100644 index dda80ade..00000000 --- a/cors-proxy/package.json +++ /dev/null @@ -1,19 +0,0 @@ -{ - "name": "@hypercerts-org/cors-proxy", - "version": "0.0.0", - "devDependencies": { - "@cloudflare/workers-types": "^4.20230115.0", - "typescript": "^4.9.5", - "vitest": "^1.0.1", - "wrangler": "2.9.1" - }, - "private": true, - "scripts": { - "dev": "wrangler dev --port 3000", - "deploy": "wrangler publish", - "lint": "tsc --noEmit && pnpm lint:eslint && pnpm lint:prettier", - "lint:eslint": "eslint --ignore-path ../.gitignore --max-warnings 0 --cache .", - "lint:prettier": "prettier --ignore-path ../.gitignore --loglevel warn --check **/*.ts", - "test": "vitest run" - } -} diff --git a/cors-proxy/src/index.test.ts b/cors-proxy/src/index.test.ts deleted file mode 100644 index 2a84fe2b..00000000 --- a/cors-proxy/src/index.test.ts +++ /dev/null @@ -1,25 +0,0 @@ -import { describe, expect, it, beforeAll, afterAll } from "vitest"; -import { unstable_dev } from "wrangler"; -import { UnstableDevWorker } from "wrangler"; - -describe("Worker", () => { - let worker: UnstableDevWorker; - - beforeAll(async () => { - worker = await unstable_dev("src/index.ts", { - experimental: { disableExperimentalWarning: true }, - }); - }); - - afterAll(async () => { - await worker.stop(); - }); - - it("should return Hello World", async () => { - const resp = await worker.fetch(); - if (resp) { - const text = await resp.text(); - expect(text).toMatchInlineSnapshot('"Missing GET parameter: url"'); - } - }); -}); diff --git a/cors-proxy/src/index.ts b/cors-proxy/src/index.ts deleted file mode 100644 index aaa9a400..00000000 --- a/cors-proxy/src/index.ts +++ /dev/null @@ -1,105 +0,0 @@ -/** - * Constants - */ -// The endpoint you want the CORS reverse proxy to be on -const CORS_HEADERS = { - "Access-Control-Allow-Origin": "*", - "Access-Control-Allow-Methods": "GET,HEAD,POST,OPTIONS", - "Access-Control-Max-Age": "86400", -}; - -const QUERYSTRING_KEY = "url"; - -// eslint-disable-next-line @typescript-eslint/no-empty-interface -export interface Env { - // Example binding to KV. Learn more at https://developers.cloudflare.com/workers/runtime-apis/kv/ - // MY_KV_NAMESPACE: KVNamespace; - // - // Example binding to Durable Object. Learn more at https://developers.cloudflare.com/workers/runtime-apis/durable-objects/ - // MY_DURABLE_OBJECT: DurableObjectNamespace; - // - // Example binding to R2. Learn more at https://developers.cloudflare.com/workers/runtime-apis/r2/ - // MY_BUCKET: R2Bucket; -} - -export default { - async fetch( - request: Request, - _env: Env, - _ctx: ExecutionContext, - ): Promise { - async function handleOptions(request: Request) { - if ( - request.headers.get("Origin") !== null && - request.headers.get("Access-Control-Request-Method") !== null && - request.headers.get("Access-Control-Request-Headers") !== null - ) { - // Handle CORS preflight requests. - const allowControlRequestHeaders = request.headers.get( - "Access-Control-Request-Headers", - ); - return new Response(null, { - headers: { - ...CORS_HEADERS, - ...(allowControlRequestHeaders - ? { - "Access-Control-Allow-Headers": allowControlRequestHeaders, - } - : {}), - }, - }); - } else { - // Handle standard OPTIONS request. - return new Response(null, { - headers: { - Allow: "GET, HEAD, POST, OPTIONS", - }, - }); - } - } - - async function handleRequest(request: Request) { - const url = new URL(request.url); - const apiUrl = url.searchParams.get(QUERYSTRING_KEY); - - if (apiUrl == null) { - return new Response(`Missing GET parameter: ${QUERYSTRING_KEY}`); - } - - // Rewrite request to point to API URL. This also makes the request mutable - // so you can add the correct Origin header to make the API server think - // that this request is not cross-site. - // TODO: Never use ts ignore - // eslint-disable-next-line @typescript-eslint/ban-ts-comment - // @ts-ignore - request = new Request(apiUrl, request); - request.headers.set("Origin", new URL(apiUrl).origin); - let response = await fetch(request); - // Recreate the response so you can modify the headers - response = new Response(response.body, response); - // Set CORS headers - //response.headers.set('Access-Control-Allow-Origin', url.origin); - response.headers.set("Access-Control-Allow-Origin", "*"); - // Append to/Add Vary header so browser will cache response correctly - response.headers.append("Vary", "Origin"); - return response; - } - - if (request.method === "OPTIONS") { - // Handle CORS preflight requests - return handleOptions(request); - } else if ( - request.method === "GET" || - request.method === "HEAD" || - request.method === "POST" - ) { - // Handle requests to the API server - return handleRequest(request); - } else { - return new Response(null, { - status: 405, - statusText: "Method Not Allowed", - }); - } - }, -}; diff --git a/cors-proxy/tsconfig.json b/cors-proxy/tsconfig.json deleted file mode 100644 index b45b2852..00000000 --- a/cors-proxy/tsconfig.json +++ /dev/null @@ -1,106 +0,0 @@ -{ - "compilerOptions": { - /* Visit https://aka.ms/tsconfig.json to read more about this file */ - - /* Projects */ - // "incremental": true, /* Enable incremental compilation */ - // "composite": true, /* Enable constraints that allow a TypeScript project to be used with project references. */ - // "tsBuildInfoFile": "./", /* Specify the folder for .tsbuildinfo incremental compilation files. */ - // "disableSourceOfProjectReferenceRedirect": true, /* Disable preferring source files instead of declaration files when referencing composite projects */ - // "disableSolutionSearching": true, /* Opt a project out of multi-project reference checking when editing. */ - // "disableReferencedProjectLoad": true, /* Reduce the number of projects loaded automatically by TypeScript. */ - - /* Language and Environment */ - "target": "es2021" /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */, - "lib": [ - "es2021" - ] /* Specify a set of bundled library declaration files that describe the target runtime environment. */, - "jsx": "react" /* Specify what JSX code is generated. */, - // "experimentalDecorators": true, /* Enable experimental support for TC39 stage 2 draft decorators. */ - // "emitDecoratorMetadata": true, /* Emit design-type metadata for decorated declarations in source files. */ - // "jsxFactory": "", /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h' */ - // "jsxFragmentFactory": "", /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */ - // "jsxImportSource": "", /* Specify module specifier used to import the JSX factory functions when using `jsx: react-jsx*`.` */ - // "reactNamespace": "", /* Specify the object invoked for `createElement`. This only applies when targeting `react` JSX emit. */ - // "noLib": true, /* Disable including any library files, including the default lib.d.ts. */ - // "useDefineForClassFields": true, /* Emit ECMAScript-standard-compliant class fields. */ - - /* Modules */ - "module": "es2022" /* Specify what module code is generated. */, - // "rootDir": "./", /* Specify the root folder within your source files. */ - "moduleResolution": "node" /* Specify how TypeScript looks up a file from a given module specifier. */, - // "baseUrl": "./", /* Specify the base directory to resolve non-relative module names. */ - // "paths": {}, /* Specify a set of entries that re-map imports to additional lookup locations. */ - // "rootDirs": [], /* Allow multiple folders to be treated as one when resolving modules. */ - // "typeRoots": [], /* Specify multiple folders that act like `./node_modules/@types`. */ - "types": [ - "@cloudflare/workers-types", - "vitest" - ] /* Specify type package names to be included without being referenced in a source file. */, - // "allowUmdGlobalAccess": true, /* Allow accessing UMD globals from modules. */ - "resolveJsonModule": true /* Enable importing .json files */, - // "noResolve": true, /* Disallow `import`s, `require`s or ``s from expanding the number of files TypeScript should add to a project. */ - - /* JavaScript Support */ - "allowJs": true /* Allow JavaScript files to be a part of your program. Use the `checkJS` option to get errors from these files. */, - "checkJs": false /* Enable error reporting in type-checked JavaScript files. */, - // "maxNodeModuleJsDepth": 1, /* Specify the maximum folder depth used for checking JavaScript files from `node_modules`. Only applicable with `allowJs`. */ - - /* Emit */ - // "declaration": true, /* Generate .d.ts files from TypeScript and JavaScript files in your project. */ - // "declarationMap": true, /* Create sourcemaps for d.ts files. */ - // "emitDeclarationOnly": true, /* Only output d.ts files and not JavaScript files. */ - // "sourceMap": true, /* Create source map files for emitted JavaScript files. */ - // "outFile": "./", /* Specify a file that bundles all outputs into one JavaScript file. If `declaration` is true, also designates a file that bundles all .d.ts output. */ - // "outDir": "./", /* Specify an output folder for all emitted files. */ - // "removeComments": true, /* Disable emitting comments. */ - "noEmit": true /* Disable emitting files from a compilation. */, - // "importHelpers": true, /* Allow importing helper functions from tslib once per project, instead of including them per-file. */ - // "importsNotUsedAsValues": "remove", /* Specify emit/checking behavior for imports that are only used for types */ - // "downlevelIteration": true, /* Emit more compliant, but verbose and less performant JavaScript for iteration. */ - // "sourceRoot": "", /* Specify the root path for debuggers to find the reference source code. */ - // "mapRoot": "", /* Specify the location where debugger should locate map files instead of generated locations. */ - // "inlineSourceMap": true, /* Include sourcemap files inside the emitted JavaScript. */ - // "inlineSources": true, /* Include source code in the sourcemaps inside the emitted JavaScript. */ - // "emitBOM": true, /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */ - // "newLine": "crlf", /* Set the newline character for emitting files. */ - // "stripInternal": true, /* Disable emitting declarations that have `@internal` in their JSDoc comments. */ - // "noEmitHelpers": true, /* Disable generating custom helper functions like `__extends` in compiled output. */ - // "noEmitOnError": true, /* Disable emitting files if any type checking errors are reported. */ - // "preserveConstEnums": true, /* Disable erasing `const enum` declarations in generated code. */ - // "declarationDir": "./", /* Specify the output directory for generated declaration files. */ - // "preserveValueImports": true, /* Preserve unused imported values in the JavaScript output that would otherwise be removed. */ - - /* Interop Constraints */ - "isolatedModules": true /* Ensure that each file can be safely transpiled without relying on other imports. */, - "allowSyntheticDefaultImports": true /* Allow 'import x from y' when a module doesn't have a default export. */, - // "esModuleInterop": true /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables `allowSyntheticDefaultImports` for type compatibility. */, - // "preserveSymlinks": true, /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */ - "forceConsistentCasingInFileNames": true /* Ensure that casing is correct in imports. */, - - /* Type Checking */ - "strict": true /* Enable all strict type-checking options. */, - // "noImplicitAny": true, /* Enable error reporting for expressions and declarations with an implied `any` type.. */ - // "strictNullChecks": true, /* When type checking, take into account `null` and `undefined`. */ - // "strictFunctionTypes": true, /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */ - // "strictBindCallApply": true, /* Check that the arguments for `bind`, `call`, and `apply` methods match the original function. */ - // "strictPropertyInitialization": true, /* Check for class properties that are declared but not set in the constructor. */ - // "noImplicitThis": true, /* Enable error reporting when `this` is given the type `any`. */ - // "useUnknownInCatchVariables": true, /* Type catch clause variables as 'unknown' instead of 'any'. */ - // "alwaysStrict": true, /* Ensure 'use strict' is always emitted. */ - // "noUnusedLocals": true, /* Enable error reporting when a local variables aren't read. */ - // "noUnusedParameters": true, /* Raise an error when a function parameter isn't read */ - // "exactOptionalPropertyTypes": true, /* Interpret optional property types as written, rather than adding 'undefined'. */ - // "noImplicitReturns": true, /* Enable error reporting for codepaths that do not explicitly return in a function. */ - // "noFallthroughCasesInSwitch": true, /* Enable error reporting for fallthrough cases in switch statements. */ - // "noUncheckedIndexedAccess": true, /* Include 'undefined' in index signature results */ - // "noImplicitOverride": true, /* Ensure overriding members in derived classes are marked with an override modifier. */ - // "noPropertyAccessFromIndexSignature": true, /* Enforces using indexed accessors for keys declared using an indexed type */ - // "allowUnusedLabels": true, /* Disable error reporting for unused labels. */ - // "allowUnreachableCode": true, /* Disable error reporting for unreachable code. */ - - /* Completeness */ - // "skipDefaultLibCheck": true, /* Skip type checking .d.ts files that are included with TypeScript. */ - "skipLibCheck": true /* Skip type checking all .d.ts files. */ - } -} diff --git a/cors-proxy/wrangler.toml b/cors-proxy/wrangler.toml deleted file mode 100644 index 877becc7..00000000 --- a/cors-proxy/wrangler.toml +++ /dev/null @@ -1,3 +0,0 @@ -name = "cors-proxy" -main = "src/index.ts" -compatibility_date = "2023-02-09" diff --git a/defender/.env.example b/defender/.env.example deleted file mode 100644 index 28d5ccb9..00000000 --- a/defender/.env.example +++ /dev/null @@ -1,2 +0,0 @@ -OPENZEPPELIN_DEFENDER_ADMIN_API_KEY=<> -OPENZEPPELIN_DEFENDER_ADMIN_API_SECRET=<> \ No newline at end of file diff --git a/defender/.eslintrc.yml b/defender/.eslintrc.yml deleted file mode 100644 index 07ab4df0..00000000 --- a/defender/.eslintrc.yml +++ /dev/null @@ -1,26 +0,0 @@ -extends: - - "eslint:recommended" - - "plugin:@typescript-eslint/eslint-recommended" - - "plugin:@typescript-eslint/recommended" - - "prettier" -parser: "@typescript-eslint/parser" -parserOptions: - project: "./defender/tsconfig.json" -plugins: - - "@typescript-eslint" -root: true -ignorePatterns: ["build/"] -rules: - "@typescript-eslint/semi": - - warn - "@typescript-eslint/switch-exhaustiveness-check": - - warn - "@typescript-eslint/no-floating-promises": - - error - - ignoreIIFE: true - ignoreVoid: true - "@typescript-eslint/no-inferrable-types": "off" - "@typescript-eslint/no-unused-vars": - - error - - argsIgnorePattern: "_" - varsIgnorePattern: "_" diff --git a/defender/README.md b/defender/README.md deleted file mode 100644 index b03429ae..00000000 --- a/defender/README.md +++ /dev/null @@ -1,15 +0,0 @@ -# Hypercerts Openzeppelin Defender integration - -Integrates the HypercertMinter contract with Openzeppelin Defender. -This updates the supabase database, where we keep a cache of `(wallet,claimId)` pairs so users -can see which fractions they might be able to claim. - -Build new auto tasks and deploy them using `yarn deploy`. -This will create [Sentinels](https://docs.openzeppelin.com/defender/sentinel) on OpenZeppelin -Defender, which will monitor for specific function calls or emitted events. -When either is monitored, an [Autotask](https://docs.openzeppelin.com/defender/autotasks) is run. -These are defined inside `src/auto-tasks/`. - -## Setup - -Copy `.env.example` to `.env` and populate your keys and configuration \ No newline at end of file diff --git a/defender/package.json b/defender/package.json deleted file mode 100644 index 2ff45321..00000000 --- a/defender/package.json +++ /dev/null @@ -1,43 +0,0 @@ -{ - "name": "@hypercerts-org/defender", - "description": "Manages OpenZeppelin Defender integrations for Hypercerts", - "version": "0.0.1", - "author": "Hypercerts Foundation", - "license": "Apache-2.0", - "main": "index.js", - "scripts": { - "build": "rimraf build && webpack", - "deploy:test": "pnpm build && pnpm setup:test", - "deploy:prod": "pnpm build && pnpm setup:prod", - "setup:test": "npx tsx src/setup.ts TEST", - "setup:prod": "npx tsx src/setup.ts PROD", - "scripts:fix-allowlist-duplicates": "npx tsx src/scripts/fix-allowlist-duplicates.ts" - }, - "dependencies": { - "@graphql-mesh/cache-localforage": "^0.95.7", - "@hypercerts-org/contracts": "1.1.2", - "@openzeppelin/defender-autotask-client": "1.54.1", - "@openzeppelin/defender-autotask-utils": "1.54.1", - "@openzeppelin/defender-base-client": "1.54.1", - "@openzeppelin/defender-sentinel-client": "1.54.1", - "@openzeppelin/merkle-tree": "^1.0.2", - "@supabase/supabase-js": "^2.4.1", - "@types/lodash": "^4.14.199", - "axios": "^1.2.6", - "dotenv": "^16.0.3", - "ethers": "5.7.2", - "lodash": "^4.17.21", - "node-fetch": "^3.3.0" - }, - "devDependencies": { - "@types/node": "^18.11.18", - "rimraf": "^5.0.5", - "terser-webpack-plugin": "^5.3.9", - "ts-loader": "^9.4.2", - "ts-node": "^10.9.1", - "tsx": "^3.14.0", - "typescript": "^4.9.4", - "webpack": "^5.75.0", - "webpack-cli": "^5.0.1" - } -} diff --git a/defender/src/HypercertMinterABI.ts b/defender/src/HypercertMinterABI.ts deleted file mode 100644 index f78f4586..00000000 --- a/defender/src/HypercertMinterABI.ts +++ /dev/null @@ -1,1117 +0,0 @@ -/** - * This is used both with the setup scripts as well as the autotasks. - * The autotasks run within a restricted environment, so difficult to - * import directly from hypercerts-sdk - */ -export const abi = `[ - { - "inputs": [], - "stateMutability": "nonpayable", - "type": "constructor" - }, - { - "inputs": [], - "name": "AlreadyClaimed", - "type": "error" - }, - { - "inputs": [], - "name": "ArraySize", - "type": "error" - }, - { - "inputs": [], - "name": "DoesNotExist", - "type": "error" - }, - { - "inputs": [], - "name": "DuplicateEntry", - "type": "error" - }, - { - "inputs": [], - "name": "Invalid", - "type": "error" - }, - { - "inputs": [], - "name": "NotAllowed", - "type": "error" - }, - { - "inputs": [], - "name": "NotApprovedOrOwner", - "type": "error" - }, - { - "inputs": [], - "name": "TransfersNotAllowed", - "type": "error" - }, - { - "inputs": [], - "name": "TypeMismatch", - "type": "error" - }, - { - "anonymous": false, - "inputs": [ - { - "indexed": false, - "internalType": "address", - "name": "previousAdmin", - "type": "address" - }, - { - "indexed": false, - "internalType": "address", - "name": "newAdmin", - "type": "address" - } - ], - "name": "AdminChanged", - "type": "event" - }, - { - "anonymous": false, - "inputs": [ - { - "indexed": false, - "internalType": "uint256", - "name": "tokenID", - "type": "uint256" - }, - { - "indexed": false, - "internalType": "bytes32", - "name": "root", - "type": "bytes32" - } - ], - "name": "AllowlistCreated", - "type": "event" - }, - { - "anonymous": false, - "inputs": [ - { - "indexed": true, - "internalType": "address", - "name": "account", - "type": "address" - }, - { - "indexed": true, - "internalType": "address", - "name": "operator", - "type": "address" - }, - { - "indexed": false, - "internalType": "bool", - "name": "approved", - "type": "bool" - } - ], - "name": "ApprovalForAll", - "type": "event" - }, - { - "anonymous": false, - "inputs": [ - { - "indexed": false, - "internalType": "uint256[]", - "name": "claimIDs", - "type": "uint256[]" - }, - { - "indexed": false, - "internalType": "uint256[]", - "name": "fromTokenIDs", - "type": "uint256[]" - }, - { - "indexed": false, - "internalType": "uint256[]", - "name": "toTokenIDs", - "type": "uint256[]" - }, - { - "indexed": false, - "internalType": "uint256[]", - "name": "values", - "type": "uint256[]" - } - ], - "name": "BatchValueTransfer", - "type": "event" - }, - { - "anonymous": false, - "inputs": [ - { - "indexed": true, - "internalType": "address", - "name": "beacon", - "type": "address" - } - ], - "name": "BeaconUpgraded", - "type": "event" - }, - { - "anonymous": false, - "inputs": [ - { - "indexed": true, - "internalType": "uint256", - "name": "claimID", - "type": "uint256" - }, - { - "indexed": false, - "internalType": "string", - "name": "uri", - "type": "string" - }, - { - "indexed": false, - "internalType": "uint256", - "name": "totalUnits", - "type": "uint256" - } - ], - "name": "ClaimStored", - "type": "event" - }, - { - "anonymous": false, - "inputs": [ - { - "indexed": false, - "internalType": "uint8", - "name": "version", - "type": "uint8" - } - ], - "name": "Initialized", - "type": "event" - }, - { - "anonymous": false, - "inputs": [ - { - "indexed": false, - "internalType": "uint256", - "name": "tokenID", - "type": "uint256" - }, - { - "indexed": false, - "internalType": "bytes32", - "name": "leaf", - "type": "bytes32" - } - ], - "name": "LeafClaimed", - "type": "event" - }, - { - "anonymous": false, - "inputs": [ - { - "indexed": true, - "internalType": "address", - "name": "previousOwner", - "type": "address" - }, - { - "indexed": true, - "internalType": "address", - "name": "newOwner", - "type": "address" - } - ], - "name": "OwnershipTransferred", - "type": "event" - }, - { - "anonymous": false, - "inputs": [ - { - "indexed": false, - "internalType": "address", - "name": "account", - "type": "address" - } - ], - "name": "Paused", - "type": "event" - }, - { - "anonymous": false, - "inputs": [ - { - "indexed": true, - "internalType": "address", - "name": "operator", - "type": "address" - }, - { - "indexed": true, - "internalType": "address", - "name": "from", - "type": "address" - }, - { - "indexed": true, - "internalType": "address", - "name": "to", - "type": "address" - }, - { - "indexed": false, - "internalType": "uint256[]", - "name": "ids", - "type": "uint256[]" - }, - { - "indexed": false, - "internalType": "uint256[]", - "name": "values", - "type": "uint256[]" - } - ], - "name": "TransferBatch", - "type": "event" - }, - { - "anonymous": false, - "inputs": [ - { - "indexed": true, - "internalType": "address", - "name": "operator", - "type": "address" - }, - { - "indexed": true, - "internalType": "address", - "name": "from", - "type": "address" - }, - { - "indexed": true, - "internalType": "address", - "name": "to", - "type": "address" - }, - { - "indexed": false, - "internalType": "uint256", - "name": "id", - "type": "uint256" - }, - { - "indexed": false, - "internalType": "uint256", - "name": "value", - "type": "uint256" - } - ], - "name": "TransferSingle", - "type": "event" - }, - { - "anonymous": false, - "inputs": [ - { - "indexed": false, - "internalType": "string", - "name": "value", - "type": "string" - }, - { - "indexed": true, - "internalType": "uint256", - "name": "id", - "type": "uint256" - } - ], - "name": "URI", - "type": "event" - }, - { - "anonymous": false, - "inputs": [ - { - "indexed": false, - "internalType": "address", - "name": "account", - "type": "address" - } - ], - "name": "Unpaused", - "type": "event" - }, - { - "anonymous": false, - "inputs": [ - { - "indexed": true, - "internalType": "address", - "name": "implementation", - "type": "address" - } - ], - "name": "Upgraded", - "type": "event" - }, - { - "anonymous": false, - "inputs": [ - { - "indexed": false, - "internalType": "uint256", - "name": "claimID", - "type": "uint256" - }, - { - "indexed": false, - "internalType": "uint256", - "name": "fromTokenID", - "type": "uint256" - }, - { - "indexed": false, - "internalType": "uint256", - "name": "toTokenID", - "type": "uint256" - }, - { - "indexed": false, - "internalType": "uint256", - "name": "value", - "type": "uint256" - } - ], - "name": "ValueTransfer", - "type": "event" - }, - { - "inputs": [], - "name": "__SemiFungible1155_init", - "outputs": [], - "stateMutability": "nonpayable", - "type": "function" - }, - { - "inputs": [ - { - "internalType": "address", - "name": "account", - "type": "address" - }, - { - "internalType": "uint256", - "name": "id", - "type": "uint256" - } - ], - "name": "balanceOf", - "outputs": [ - { - "internalType": "uint256", - "name": "", - "type": "uint256" - } - ], - "stateMutability": "view", - "type": "function" - }, - { - "inputs": [ - { - "internalType": "address[]", - "name": "accounts", - "type": "address[]" - }, - { - "internalType": "uint256[]", - "name": "ids", - "type": "uint256[]" - } - ], - "name": "balanceOfBatch", - "outputs": [ - { - "internalType": "uint256[]", - "name": "", - "type": "uint256[]" - } - ], - "stateMutability": "view", - "type": "function" - }, - { - "inputs": [ - { - "internalType": "address", - "name": "account", - "type": "address" - }, - { - "internalType": "bytes32[][]", - "name": "proofs", - "type": "bytes32[][]" - }, - { - "internalType": "uint256[]", - "name": "claimIDs", - "type": "uint256[]" - }, - { - "internalType": "uint256[]", - "name": "units", - "type": "uint256[]" - } - ], - "name": "batchMintClaimsFromAllowlists", - "outputs": [], - "stateMutability": "nonpayable", - "type": "function" - }, - { - "inputs": [ - { - "internalType": "address", - "name": "account", - "type": "address" - }, - { - "internalType": "uint256", - "name": "id", - "type": "uint256" - }, - { - "internalType": "uint256", - "name": "value", - "type": "uint256" - } - ], - "name": "burn", - "outputs": [], - "stateMutability": "nonpayable", - "type": "function" - }, - { - "inputs": [ - { - "internalType": "address", - "name": "account", - "type": "address" - }, - { - "internalType": "uint256[]", - "name": "ids", - "type": "uint256[]" - }, - { - "internalType": "uint256[]", - "name": "values", - "type": "uint256[]" - } - ], - "name": "burnBatch", - "outputs": [], - "stateMutability": "nonpayable", - "type": "function" - }, - { - "inputs": [ - { - "internalType": "address", - "name": "_account", - "type": "address" - }, - { - "internalType": "uint256", - "name": "_tokenID", - "type": "uint256" - } - ], - "name": "burnFraction", - "outputs": [], - "stateMutability": "nonpayable", - "type": "function" - }, - { - "inputs": [ - { - "internalType": "address", - "name": "account", - "type": "address" - }, - { - "internalType": "uint256", - "name": "units", - "type": "uint256" - }, - { - "internalType": "bytes32", - "name": "merkleRoot", - "type": "bytes32" - }, - { - "internalType": "string", - "name": "_uri", - "type": "string" - }, - { - "internalType": "enum IHypercertToken.TransferRestrictions", - "name": "restrictions", - "type": "uint8" - } - ], - "name": "createAllowlist", - "outputs": [], - "stateMutability": "nonpayable", - "type": "function" - }, - { - "inputs": [ - { - "internalType": "uint256", - "name": "", - "type": "uint256" - }, - { - "internalType": "bytes32", - "name": "", - "type": "bytes32" - } - ], - "name": "hasBeenClaimed", - "outputs": [ - { - "internalType": "bool", - "name": "", - "type": "bool" - } - ], - "stateMutability": "view", - "type": "function" - }, - { - "inputs": [], - "name": "initialize", - "outputs": [], - "stateMutability": "nonpayable", - "type": "function" - }, - { - "inputs": [ - { - "internalType": "bytes32[]", - "name": "proof", - "type": "bytes32[]" - }, - { - "internalType": "uint256", - "name": "claimID", - "type": "uint256" - }, - { - "internalType": "bytes32", - "name": "leaf", - "type": "bytes32" - } - ], - "name": "isAllowedToClaim", - "outputs": [ - { - "internalType": "bool", - "name": "isAllowed", - "type": "bool" - } - ], - "stateMutability": "view", - "type": "function" - }, - { - "inputs": [ - { - "internalType": "address", - "name": "account", - "type": "address" - }, - { - "internalType": "address", - "name": "operator", - "type": "address" - } - ], - "name": "isApprovedForAll", - "outputs": [ - { - "internalType": "bool", - "name": "", - "type": "bool" - } - ], - "stateMutability": "view", - "type": "function" - }, - { - "inputs": [ - { - "internalType": "address", - "name": "_account", - "type": "address" - }, - { - "internalType": "uint256[]", - "name": "_fractionIDs", - "type": "uint256[]" - } - ], - "name": "mergeFractions", - "outputs": [], - "stateMutability": "nonpayable", - "type": "function" - }, - { - "inputs": [ - { - "internalType": "address", - "name": "account", - "type": "address" - }, - { - "internalType": "uint256", - "name": "units", - "type": "uint256" - }, - { - "internalType": "string", - "name": "_uri", - "type": "string" - }, - { - "internalType": "enum IHypercertToken.TransferRestrictions", - "name": "restrictions", - "type": "uint8" - } - ], - "name": "mintClaim", - "outputs": [], - "stateMutability": "nonpayable", - "type": "function" - }, - { - "inputs": [ - { - "internalType": "address", - "name": "account", - "type": "address" - }, - { - "internalType": "bytes32[]", - "name": "proof", - "type": "bytes32[]" - }, - { - "internalType": "uint256", - "name": "claimID", - "type": "uint256" - }, - { - "internalType": "uint256", - "name": "units", - "type": "uint256" - } - ], - "name": "mintClaimFromAllowlist", - "outputs": [], - "stateMutability": "nonpayable", - "type": "function" - }, - { - "inputs": [ - { - "internalType": "address", - "name": "account", - "type": "address" - }, - { - "internalType": "uint256", - "name": "units", - "type": "uint256" - }, - { - "internalType": "uint256[]", - "name": "fractions", - "type": "uint256[]" - }, - { - "internalType": "string", - "name": "_uri", - "type": "string" - }, - { - "internalType": "enum IHypercertToken.TransferRestrictions", - "name": "restrictions", - "type": "uint8" - } - ], - "name": "mintClaimWithFractions", - "outputs": [], - "stateMutability": "nonpayable", - "type": "function" - }, - { - "inputs": [], - "name": "name", - "outputs": [ - { - "internalType": "string", - "name": "", - "type": "string" - } - ], - "stateMutability": "view", - "type": "function" - }, - { - "inputs": [], - "name": "owner", - "outputs": [ - { - "internalType": "address", - "name": "", - "type": "address" - } - ], - "stateMutability": "view", - "type": "function" - }, - { - "inputs": [ - { - "internalType": "uint256", - "name": "tokenID", - "type": "uint256" - } - ], - "name": "ownerOf", - "outputs": [ - { - "internalType": "address", - "name": "_owner", - "type": "address" - } - ], - "stateMutability": "view", - "type": "function" - }, - { - "inputs": [], - "name": "pause", - "outputs": [], - "stateMutability": "nonpayable", - "type": "function" - }, - { - "inputs": [], - "name": "paused", - "outputs": [ - { - "internalType": "bool", - "name": "", - "type": "bool" - } - ], - "stateMutability": "view", - "type": "function" - }, - { - "inputs": [], - "name": "proxiableUUID", - "outputs": [ - { - "internalType": "bytes32", - "name": "", - "type": "bytes32" - } - ], - "stateMutability": "view", - "type": "function" - }, - { - "inputs": [ - { - "internalType": "uint256", - "name": "tokenID", - "type": "uint256" - } - ], - "name": "readTransferRestriction", - "outputs": [ - { - "internalType": "string", - "name": "", - "type": "string" - } - ], - "stateMutability": "view", - "type": "function" - }, - { - "inputs": [], - "name": "renounceOwnership", - "outputs": [], - "stateMutability": "nonpayable", - "type": "function" - }, - { - "inputs": [ - { - "internalType": "address", - "name": "from", - "type": "address" - }, - { - "internalType": "address", - "name": "to", - "type": "address" - }, - { - "internalType": "uint256[]", - "name": "ids", - "type": "uint256[]" - }, - { - "internalType": "uint256[]", - "name": "amounts", - "type": "uint256[]" - }, - { - "internalType": "bytes", - "name": "data", - "type": "bytes" - } - ], - "name": "safeBatchTransferFrom", - "outputs": [], - "stateMutability": "nonpayable", - "type": "function" - }, - { - "inputs": [ - { - "internalType": "address", - "name": "from", - "type": "address" - }, - { - "internalType": "address", - "name": "to", - "type": "address" - }, - { - "internalType": "uint256", - "name": "id", - "type": "uint256" - }, - { - "internalType": "uint256", - "name": "amount", - "type": "uint256" - }, - { - "internalType": "bytes", - "name": "data", - "type": "bytes" - } - ], - "name": "safeTransferFrom", - "outputs": [], - "stateMutability": "nonpayable", - "type": "function" - }, - { - "inputs": [ - { - "internalType": "address", - "name": "operator", - "type": "address" - }, - { - "internalType": "bool", - "name": "approved", - "type": "bool" - } - ], - "name": "setApprovalForAll", - "outputs": [], - "stateMutability": "nonpayable", - "type": "function" - }, - { - "inputs": [ - { - "internalType": "address", - "name": "_account", - "type": "address" - }, - { - "internalType": "uint256", - "name": "_tokenID", - "type": "uint256" - }, - { - "internalType": "uint256[]", - "name": "_newFractions", - "type": "uint256[]" - } - ], - "name": "splitFraction", - "outputs": [], - "stateMutability": "nonpayable", - "type": "function" - }, - { - "inputs": [ - { - "internalType": "bytes4", - "name": "interfaceId", - "type": "bytes4" - } - ], - "name": "supportsInterface", - "outputs": [ - { - "internalType": "bool", - "name": "", - "type": "bool" - } - ], - "stateMutability": "view", - "type": "function" - }, - { - "inputs": [ - { - "internalType": "address", - "name": "newOwner", - "type": "address" - } - ], - "name": "transferOwnership", - "outputs": [], - "stateMutability": "nonpayable", - "type": "function" - }, - { - "inputs": [ - { - "internalType": "address", - "name": "account", - "type": "address" - }, - { - "internalType": "uint256", - "name": "tokenID", - "type": "uint256" - } - ], - "name": "unitsOf", - "outputs": [ - { - "internalType": "uint256", - "name": "units", - "type": "uint256" - } - ], - "stateMutability": "view", - "type": "function" - }, - { - "inputs": [ - { - "internalType": "uint256", - "name": "tokenID", - "type": "uint256" - } - ], - "name": "unitsOf", - "outputs": [ - { - "internalType": "uint256", - "name": "units", - "type": "uint256" - } - ], - "stateMutability": "view", - "type": "function" - }, - { - "inputs": [], - "name": "unpause", - "outputs": [], - "stateMutability": "nonpayable", - "type": "function" - }, - { - "inputs": [ - { - "internalType": "address", - "name": "newImplementation", - "type": "address" - } - ], - "name": "upgradeTo", - "outputs": [], - "stateMutability": "nonpayable", - "type": "function" - }, - { - "inputs": [ - { - "internalType": "address", - "name": "newImplementation", - "type": "address" - }, - { - "internalType": "bytes", - "name": "data", - "type": "bytes" - } - ], - "name": "upgradeToAndCall", - "outputs": [], - "stateMutability": "payable", - "type": "function" - }, - { - "inputs": [ - { - "internalType": "uint256", - "name": "tokenID", - "type": "uint256" - } - ], - "name": "uri", - "outputs": [ - { - "internalType": "string", - "name": "_uri", - "type": "string" - } - ], - "stateMutability": "view", - "type": "function" - } -]`; diff --git a/defender/src/auto-tasks/batch-mint-claims-from-allowlists.ts b/defender/src/auto-tasks/batch-mint-claims-from-allowlists.ts deleted file mode 100644 index 578f6aa8..00000000 --- a/defender/src/auto-tasks/batch-mint-claims-from-allowlists.ts +++ /dev/null @@ -1,122 +0,0 @@ -import { - AutotaskEvent, - BlockTriggerEvent, -} from "@openzeppelin/defender-autotask-utils"; -import { HypercertMinterAbi } from "@hypercerts-org/contracts"; -import { MissingDataError, NotImplementedError } from "../errors"; -import { - getNetworkConfigFromName, - SUPABASE_ALLOWLIST_TABLE_NAME, -} from "../networks"; -import { createClient } from "@supabase/supabase-js"; -import { BigNumber, ethers } from "ethers"; -import fetch from "node-fetch"; - -export async function handler(event: AutotaskEvent) { - const network = getNetworkConfigFromName(event.autotaskName); - const { SUPABASE_URL, SUPABASE_SECRET_API_KEY } = event.secrets; - const ALCHEMY_KEY = event.secrets[network.alchemyKeyEnvName]; - const client = createClient(SUPABASE_URL, SUPABASE_SECRET_API_KEY, { - global: { - // eslint-disable-next-line @typescript-eslint/ban-ts-comment - // @ts-ignore - fetch: (...args) => fetch(...args), - }, - }); - - let provider; - - if (ALCHEMY_KEY) { - provider = new ethers.providers.AlchemyProvider( - network.networkKey, - ALCHEMY_KEY, - ); - } else if (network.rpc) { - provider = new ethers.providers.JsonRpcProvider(network.rpc); - } else { - throw new Error("No provider available"); - } - - // Check data availability - const body = event.request.body; - if (!("type" in body) || body.type !== "BLOCK") { - throw new NotImplementedError("Event body is not a BlockTriggerEvent"); - } - const blockTriggerEvent = body as BlockTriggerEvent; - const contractAddress = blockTriggerEvent.matchedAddresses[0]; - const fromAddress = blockTriggerEvent.transaction.from; - const txnLogs = blockTriggerEvent.transaction.logs; - const tx = await provider.getTransaction(blockTriggerEvent.hash); - - if (!contractAddress) { - throw new MissingDataError(`body.matchedAddresses is missing`); - } else if (!fromAddress) { - throw new MissingDataError(`body.transaction.from is missing`); - } else if (!txnLogs) { - throw new MissingDataError(`body.transaction.logs is missing`); - } else if (!tx) { - throw new MissingDataError(`tx is missing`); - } - - console.log("Contract address", contractAddress); - console.log("From address", fromAddress); - - const contractInterface = new ethers.utils.Interface(HypercertMinterAbi); - - // Parse events - // Parse events - const batchTransferEvents = txnLogs - .map((l) => { - //Ignore unknown events - try { - return contractInterface.parseLog(l); - } catch (e) { - console.log("Failed to parse log", l); - return null; - } - }) - .filter((e) => e !== null && e.name === "BatchValueTransfer"); - - console.log( - "BatchTransfer Events: ", - JSON.stringify(batchTransferEvents, null, 2), - ); - - if (batchTransferEvents.length !== 1) { - throw new MissingDataError( - `Unexpected saw ${batchTransferEvents.length} BatchValueTransfer events`, - ); - } - - // Get claimIDs - const claimIds = batchTransferEvents[0].args[0] as BigNumber[]; - console.log("ClaimIDs: ", claimIds.toString()); - - const formattedClaimIds = claimIds.map( - (claimId) => `${contractAddress}-${claimId.toString().toLowerCase()}`, - ); - console.log("Formatted claim ids", formattedClaimIds); - - const uniqueClaimdIds = [...new Set(formattedClaimIds)]; - - // Wait for transaction to be confirmed for 5 blocks - if (await tx.wait(5).then((receipt) => receipt.status === 1)) { - console.log("Transaction confirmed"); - const deleteResult = await client - .from(SUPABASE_ALLOWLIST_TABLE_NAME) - .delete() - .eq("address", fromAddress) - .in("claimId", uniqueClaimdIds) - .select(); - - console.log("delete result", deleteResult); - - if (!deleteResult) { - throw new Error( - `Could not remove from database. Delete result: ${JSON.stringify( - deleteResult, - )}`, - ); - } - } -} diff --git a/defender/src/auto-tasks/execute-taker-bid.ts b/defender/src/auto-tasks/execute-taker-bid.ts deleted file mode 100644 index ccc2c040..00000000 --- a/defender/src/auto-tasks/execute-taker-bid.ts +++ /dev/null @@ -1,168 +0,0 @@ -import { - AutotaskEvent, - BlockTriggerEvent, -} from "@openzeppelin/defender-autotask-utils"; -import { getNetworkConfigFromName } from "../networks"; -import { createClient } from "@supabase/supabase-js"; -import fetch from "node-fetch"; -import { BigNumber, ethers } from "ethers"; -import { MissingDataError, NotImplementedError } from "../errors"; -import { - HypercertExchangeAbi, - HypercertMinterAbi, -} from "@hypercerts-org/contracts"; - -export async function handler(event: AutotaskEvent) { - console.log( - "Event: ", - JSON.stringify( - { ...event, secrets: "HIDDEN", credentials: "HIDDEN" }, - null, - 2, - ), - ); - const network = getNetworkConfigFromName(event.autotaskName); - const { SUPABASE_URL, SUPABASE_SECRET_API_KEY } = event.secrets; - const ALCHEMY_KEY = event.secrets[network.alchemyKeyEnvName]; - - const client = createClient(SUPABASE_URL, SUPABASE_SECRET_API_KEY, { - global: { - // eslint-disable-next-line @typescript-eslint/ban-ts-comment - // @ts-ignore - fetch: (...args) => fetch(...args), - }, - }); - - let provider; - - if (ALCHEMY_KEY) { - provider = new ethers.providers.AlchemyProvider( - network.networkKey, - ALCHEMY_KEY, - ); - } else if (network.rpc) { - provider = new ethers.providers.JsonRpcProvider(network.rpc); - } else { - throw new Error("No provider available"); - } - - // Check data availability - const body = event.request.body; - if (!("type" in body) || body.type !== "BLOCK") { - throw new NotImplementedError("Event body is not a BlockTriggerEvent"); - } - const blockTriggerEvent = body as BlockTriggerEvent; - const contractAddress = blockTriggerEvent.matchedAddresses[0]; - const fromAddress = blockTriggerEvent.transaction.from; - const txnLogs = blockTriggerEvent.transaction.logs; - const tx = await provider.getTransaction(blockTriggerEvent.hash); - - if (!contractAddress) { - throw new MissingDataError(`body.matchedAddresses is missing`); - } else if (!fromAddress) { - throw new MissingDataError(`body.transaction.from is missing`); - } else if (!txnLogs) { - throw new MissingDataError(`body.transaction.logs is missing`); - } else if (!tx) { - throw new MissingDataError(`tx is missing`); - } - - console.log("Contract address", contractAddress); - console.log("From address", fromAddress); - - // TODO: Update contracts so we can use ABI from the @hypercerts-org/contracts package - const hypercertsMinterContractInterface = new ethers.utils.Interface( - HypercertMinterAbi, - ); - - // Parse TransferSingle events - const parsedLogs = txnLogs.map((l) => { - //Ignore unknown events - try { - return hypercertsMinterContractInterface.parseLog(l); - } catch (e) { - console.log("Failed to parse log", l); - return null; - } - }); - console.log("Parsed logs: ", JSON.stringify(parsedLogs, null, 2)); - const transferSingleEvents = parsedLogs.filter( - (e) => e !== null && e.name === "TransferSingle", - ); - - console.log( - "TransferSingle Events: ", - JSON.stringify(transferSingleEvents, null, 2), - ); - - if (transferSingleEvents.length !== 1) { - throw new MissingDataError( - `Unexpected saw ${transferSingleEvents.length} TransferSingle events`, - ); - } - - // Get claimID - const signerAddress = transferSingleEvents[0].args["from"] as string; - const itemId = BigNumber.from(transferSingleEvents[0].args["id"]).toString(); - - const hypercertExchangeContractInterface = new ethers.utils.Interface( - HypercertExchangeAbi, - ); - // Parse TakerBid events - const takerBidEvents = txnLogs - .map((l) => { - //Ignore unknown events - try { - return hypercertExchangeContractInterface.parseLog(l); - } catch (e) { - console.log("Failed to parse log", l); - return null; - } - }) - .filter((e) => e !== null && e.name === "TakerBid"); - - console.log("TakerBid Events: ", JSON.stringify(takerBidEvents, null, 2)); - - if (takerBidEvents.length !== 1) { - throw new MissingDataError( - `Unexpected saw ${takerBidEvents.length} TakerBid events`, - ); - } - - // Get claimID - const orderNonce = BigNumber.from( - takerBidEvents[0].args["nonceInvalidationParameters"][1], - ).toString(); - console.log( - "Signer Address: ", - signerAddress, - "Order nonce: ", - orderNonce, - "Fraction ID: ", - itemId, - "Chain ID: ", - network.chainId, - ); - - // Remove from DB - if (await tx.wait(5).then((receipt) => receipt.status === 1)) { - const deleteResult = await client - .from("marketplace-orders") - .delete() - .eq("signer", signerAddress) - .eq("chainId", network.chainId) - .eq("orderNonce", orderNonce) - .containedBy("itemIds", [itemId]) - .select() - .throwOnError(); - console.log("Deleted", deleteResult); - - if (!deleteResult) { - throw new Error( - `Could not remove from database. Delete result: ${JSON.stringify( - deleteResult, - )}`, - ); - } - } -} diff --git a/defender/src/auto-tasks/mint-claim-from-allowlist.ts b/defender/src/auto-tasks/mint-claim-from-allowlist.ts deleted file mode 100644 index b53ca014..00000000 --- a/defender/src/auto-tasks/mint-claim-from-allowlist.ts +++ /dev/null @@ -1,130 +0,0 @@ -import { HypercertMinterAbi } from "@hypercerts-org/contracts"; -import { MissingDataError, NotImplementedError } from "../errors"; -import { - getNetworkConfigFromName, - SUPABASE_ALLOWLIST_TABLE_NAME, -} from "../networks"; -import { - AutotaskEvent, - BlockTriggerEvent, -} from "@openzeppelin/defender-autotask-utils"; -import { createClient } from "@supabase/supabase-js"; -import { ethers } from "ethers"; -import fetch from "node-fetch"; - -export async function handler(event: AutotaskEvent) { - console.log( - "Event: ", - JSON.stringify( - { ...event, secrets: "HIDDEN", credentials: "HIDDEN" }, - null, - 2, - ), - ); - const network = getNetworkConfigFromName(event.autotaskName); - const { SUPABASE_URL, SUPABASE_SECRET_API_KEY } = event.secrets; - const ALCHEMY_KEY = event.secrets[network.alchemyKeyEnvName]; - - const client = createClient(SUPABASE_URL, SUPABASE_SECRET_API_KEY, { - global: { - // eslint-disable-next-line @typescript-eslint/ban-ts-comment - // @ts-ignore - fetch: (...args) => fetch(...args), - }, - }); - - let provider; - - if (ALCHEMY_KEY) { - provider = new ethers.providers.AlchemyProvider( - network.networkKey, - ALCHEMY_KEY, - ); - } else if (network.rpc) { - provider = new ethers.providers.JsonRpcProvider(network.rpc); - } else { - throw new Error("No provider available"); - } - - // Check data availability - const body = event.request.body; - if (!("type" in body) || body.type !== "BLOCK") { - throw new NotImplementedError("Event body is not a BlockTriggerEvent"); - } - const blockTriggerEvent = body as BlockTriggerEvent; - const contractAddress = blockTriggerEvent.matchedAddresses[0]; - const fromAddress = blockTriggerEvent.transaction.from; - const txnLogs = blockTriggerEvent.transaction.logs; - const tx = await provider.getTransaction(blockTriggerEvent.hash); - - if (!contractAddress) { - throw new MissingDataError(`body.matchedAddresses is missing`); - } else if (!fromAddress) { - throw new MissingDataError(`body.transaction.from is missing`); - } else if (!txnLogs) { - throw new MissingDataError(`body.transaction.logs is missing`); - } else if (!tx) { - throw new MissingDataError(`tx is missing`); - } - - console.log("Contract address", contractAddress); - console.log("From address", fromAddress); - - const contractInterface = new ethers.utils.Interface(HypercertMinterAbi); - - // Parse events - const batchTransferEvents = txnLogs - .map((l) => { - //Ignore unknown events - try { - return contractInterface.parseLog(l); - } catch (e) { - console.log("Failed to parse log", l); - return null; - } - }) - .filter((e) => e !== null && e.name === "BatchValueTransfer"); - - console.log( - "BatchTransfer Events: ", - JSON.stringify(batchTransferEvents, null, 2), - ); - - if (batchTransferEvents.length !== 1) { - throw new MissingDataError( - `Unexpected saw ${batchTransferEvents.length} BatchValueTransfer events`, - ); - } - - // Get claimID - const claimId = batchTransferEvents[0].args["claimIDs"][0] as string; - console.log( - "ClaimID: ", - batchTransferEvents[0].args["claimIDs"][0].toString(), - ); - - const formattedClaimId = `${contractAddress}-${claimId - .toString() - .toLowerCase()}`; - console.log("Formatted claim id", formattedClaimId); - - // Remove from DB - if (await tx.wait(5).then((receipt) => receipt.status === 1)) { - const deleteResult = await client - .from(SUPABASE_ALLOWLIST_TABLE_NAME) - .delete() - .eq("address", fromAddress) - .eq("claimId", formattedClaimId) - .eq("chainId", network.chainId) - .select(); - console.log("Deleted", deleteResult); - - if (!deleteResult) { - throw new Error( - `Could not remove from database. Delete result: ${JSON.stringify( - deleteResult, - )}`, - ); - } - } -} diff --git a/defender/src/auto-tasks/on-allowlist-created.ts b/defender/src/auto-tasks/on-allowlist-created.ts deleted file mode 100644 index 0e73472b..00000000 --- a/defender/src/auto-tasks/on-allowlist-created.ts +++ /dev/null @@ -1,151 +0,0 @@ -import { MissingDataError, NotImplementedError } from "../errors"; -import { - AutotaskEvent, - BlockTriggerEvent, -} from "@openzeppelin/defender-autotask-utils"; -import { - getNetworkConfigFromName, - SUPABASE_ALLOWLIST_TABLE_NAME, -} from "../networks"; -import { StandardMerkleTree } from "@openzeppelin/merkle-tree"; -import { createClient } from "@supabase/supabase-js"; -import { ethers } from "ethers"; -import fetch from "node-fetch"; -import axios from "axios"; -import { HypercertMinterAbi } from "@hypercerts-org/contracts"; - -const getIpfsGatewayUri = (cidOrIpfsUri: string) => { - const NFT_STORAGE_IPFS_GATEWAY = "https://nftstorage.link/ipfs/{cid}"; - const cid = cidOrIpfsUri.replace("ipfs://", ""); - return NFT_STORAGE_IPFS_GATEWAY.replace("{cid}", cid); -}; - -export const getData = async (cidOrIpfsUri: string) => { - const ipfsGatewayLink = getIpfsGatewayUri(cidOrIpfsUri); - console.log(`Getting metadata ${cidOrIpfsUri} at ${ipfsGatewayLink}`); - return axios.get(ipfsGatewayLink).then((result) => result.data); -}; - -export async function handler(event: AutotaskEvent) { - console.log( - "Event: ", - JSON.stringify( - { ...event, secrets: "HIDDEN", credentials: "HIDDEN" }, - null, - 2, - ), - ); - const network = getNetworkConfigFromName(event.autotaskName); - const { SUPABASE_URL, SUPABASE_SECRET_API_KEY } = event.secrets; - const ALCHEMY_KEY = event.secrets[network.alchemyKeyEnvName]; - const client = createClient(SUPABASE_URL, SUPABASE_SECRET_API_KEY, { - global: { - // eslint-disable-next-line @typescript-eslint/ban-ts-comment - // @ts-ignore - fetch: (...args) => fetch(...args), - }, - }); - const body = event.request.body; - if (!("type" in body) || body.type !== "BLOCK") { - throw new NotImplementedError("Event body is not a BlockTriggerEvent"); - } - const blockTriggerEvent = body as BlockTriggerEvent; - const contractAddress = blockTriggerEvent.matchedAddresses[0]; - const txnLogs = blockTriggerEvent.transaction.logs; - if (!contractAddress) { - throw new MissingDataError(`body.matchedAddresses is missing`); - } else if (!txnLogs) { - throw new MissingDataError(`body.transaction.logs is missing`); - } - console.log("Contract address", contractAddress); - - let provider; - - if (ALCHEMY_KEY) { - provider = new ethers.providers.AlchemyProvider( - network.networkKey, - ALCHEMY_KEY, - ); - } else if (network.rpc) { - provider = new ethers.providers.JsonRpcProvider(network.rpc); - } else { - throw new Error("No provider available"); - } - - const contract = new ethers.Contract( - contractAddress, - HypercertMinterAbi, - provider, - ); - - //Ignore unknown events - const allowlistCreatedEvents = txnLogs - .map((l) => { - try { - return contract.interface.parseLog(l); - } catch (e) { - console.log("Failed to parse log", l); - return null; - } - }) - .filter((e) => e !== null && e.name === "AllowlistCreated"); - - console.log( - "AllowlistCreated Events: ", - JSON.stringify(allowlistCreatedEvents, null, 2), - ); - - if (allowlistCreatedEvents.length !== 1) { - throw new MissingDataError( - `Unexpected saw ${allowlistCreatedEvents.length} AllowlistCreated events`, - ); - } - - const tokenId = allowlistCreatedEvents[0].args[0].toString(); - console.log("TokenId: ", tokenId); - - const metadataUri = await contract.functions.uri(tokenId); - console.log("metadataUri: ", metadataUri); - - const metadata = await getData(metadataUri[0]); - if (!metadata?.allowList) { - throw new Error(`No allowlist found`); - } - - console.log("allowlist: ", metadata.allowList); - - // Get allowlist - const treeResponse = await getData(metadata.allowList); - if (!treeResponse) { - throw new Error("Could not fetch json tree dump for allowlist"); - } - const tree = StandardMerkleTree.load(JSON.parse(treeResponse)); - - // Find the proof - const addresses: string[] = []; - for (const [, v] of tree.entries()) { - addresses.push(v[0]); - } - console.log("addresses", addresses); - const data = addresses.map((address, index) => ({ - address: address.toLowerCase(), - claimId: `${contractAddress}-${tokenId}`, - fractionCounter: index, - chainId: network.chainId, - })); - console.log("data", data); - - const addResult = await client - .from(SUPABASE_ALLOWLIST_TABLE_NAME) - .insert(data) - .select() - .then((data) => data.data); - - console.log("add result", addResult); - - if (!addResult) { - throw new Error( - `Could not add to database. Add result: ${JSON.stringify(addResult)}`, - ); - } -} diff --git a/defender/src/config.ts b/defender/src/config.ts deleted file mode 100644 index 09daf322..00000000 --- a/defender/src/config.ts +++ /dev/null @@ -1,34 +0,0 @@ -import { NETWORKS, SupportedNetworks } from "./networks"; -import * as dotenv from "dotenv"; - -dotenv.config(); - -const requireEnv = (value: string | undefined, identifier: string) => { - if (!value) { - throw new Error(`Required env var ${identifier} does not exist`); - } - return value; -}; - -interface Config { - networks: SupportedNetworks; - credentials: { - apiKey: string; - apiSecret: string; - }; -} - -const config: Config = { - networks: NETWORKS, - credentials: { - apiKey: requireEnv( - process.env.OPENZEPPELIN_DEFENDER_ADMIN_API_KEY, - "OPENZEPPELIN_DEFENDER_ADMIN_API_KEY", - ), - apiSecret: requireEnv( - process.env.OPENZEPPELIN_DEFENDER_ADMIN_API_SECRET, - "OPENZEPPELIN_DEFENDER_ADMIN_API_SECRET", - ), - }, -}; -export default config; diff --git a/defender/src/create-autotask.ts b/defender/src/create-autotask.ts deleted file mode 100644 index 6cecaddd..00000000 --- a/defender/src/create-autotask.ts +++ /dev/null @@ -1,26 +0,0 @@ -import config from "./config"; -import { AutotaskClient } from "@openzeppelin/defender-autotask-client"; -import { SentinelTrigger } from "@openzeppelin/defender-autotask-client/lib/models/autotask.js"; - -export const createTask = async (name: string, file: string) => { - const client = new AutotaskClient(config.credentials); - const taskConfig = { - name, - encodedZippedCode: await client.getEncodedZippedCodeFromFolder( - `./build/relay/${file}`, - ), - paused: false, - trigger: { type: "sentinel" } as SentinelTrigger, - }; - - return await client - .create(taskConfig) - .then((res) => { - console.log("Created autotask", name, "with id", res.autotaskId); - return res; - }) - .catch((error) => { - console.error(error); - return null; - }); -}; diff --git a/defender/src/create-sentinel.ts b/defender/src/create-sentinel.ts deleted file mode 100644 index 55274f0d..00000000 --- a/defender/src/create-sentinel.ts +++ /dev/null @@ -1,56 +0,0 @@ -import config from "./config.js"; -import { NetworkConfig } from "./networks"; -import { SentinelClient } from "@openzeppelin/defender-sentinel-client"; -import { - EventCondition, - FunctionCondition, -} from "@openzeppelin/defender-sentinel-client/lib/models/subscriber.js"; - -export const createSentinel = async ({ - name, - network, - autotaskID, - functionConditions = [], - eventConditions = [], - contractAddress, - abi, -}: { - name: string; - network: NetworkConfig; - autotaskID: string; - eventConditions?: EventCondition[]; - functionConditions?: FunctionCondition[]; - contractAddress: string; - abi: any; -}) => { - const client = new SentinelClient(config.credentials); - await client - .create({ - type: "BLOCK", - network: network.networkKey, - confirmLevel: 1, // if not set, we pick the blockwatcher for the chosen network with the lowest offset - name, - addresses: [contractAddress], - abi, - paused: false, - eventConditions, - functionConditions, - alertTimeoutMs: 0, - notificationChannels: [], - autotaskTrigger: autotaskID, - }) - .then((res) => { - console.log( - `Created sentinel`, - res.name, - "- monitoring address", - contractAddress, - "- linked to autotask", - autotaskID, - ); - return res; - }) - .catch((error) => { - console.error(error); - }); -}; diff --git a/defender/src/errors.ts b/defender/src/errors.ts deleted file mode 100644 index 66df3372..00000000 --- a/defender/src/errors.ts +++ /dev/null @@ -1,19 +0,0 @@ -/** - * Error interfacing with OpenZeppelin API - */ -export class ApiError extends Error {} - -/** - * Misconfigured. Check your environment variables or `src/config.ts` - */ -export class ConfigError extends Error {} - -/** - * This is a pathway that hasn't been implemented yet - */ -export class NotImplementedError extends Error {} - -/** - * This is a pathway that hasn't been implemented yet - */ -export class MissingDataError extends Error {} diff --git a/defender/src/networks.ts b/defender/src/networks.ts deleted file mode 100644 index 1321b812..00000000 --- a/defender/src/networks.ts +++ /dev/null @@ -1,109 +0,0 @@ -import { Network } from "@openzeppelin/defender-base-client"; -import { deployments } from "@hypercerts-org/contracts"; - -export interface NetworkConfig { - // Used to identify the network for both Alchemy and OpenZeppelin Sentinel - networkKey: Network; - // Minter contract address on the network - hypercertMinterContractAddress: string; - // Exchange contract address on the network - hypercertExchangeContractAddress?: string; - // the selector to retrieve the key from event.secrets in OpenZeppelin - alchemyKeyEnvName?: string; - // Chain ID for the network - chainId: number; - rpc?: string; -} - -export const SUPABASE_ALLOWLIST_TABLE_NAME = "allowlistCache-chainId"; - -export interface SupportedNetworks { - TEST: NetworkConfig[]; - PROD: NetworkConfig[]; -} - -export const NETWORKS: SupportedNetworks = { - TEST: [ - { - networkKey: "sepolia", - hypercertMinterContractAddress: - deployments["11155111"].HypercertMinterUUPS, - hypercertExchangeContractAddress: - deployments["11155111"].HypercertExchange, - chainId: 11155111, - rpc: "https://rpc.sepolia.org", - }, - { - networkKey: "base-sepolia", - hypercertMinterContractAddress: deployments["84532"].HypercertMinterUUPS, - hypercertExchangeContractAddress: deployments["84532"].HypercertExchange, - chainId: 84532, - rpc: "https://base-sepolia-rpc.publicnode.com", - }, - ], - PROD: [ - { - networkKey: "optimism", - hypercertMinterContractAddress: deployments["10"].HypercertMinterUUPS, - alchemyKeyEnvName: "ALCHEMY_OPTIMISM_KEY", - chainId: 10, - }, - { - networkKey: "celo", - hypercertMinterContractAddress: deployments["42220"].HypercertMinterUUPS, - chainId: 42220, - rpc: "https://forno.celo.org", - }, - { - networkKey: "base", - hypercertMinterContractAddress: deployments["8453"].HypercertMinterUUPS, - chainId: 8453, - rpc: "https://mainnet.base.org", - }, - ], -}; - -/** - * We'll use this to encode the network name into the Sentinel/Autotask name - * We'll then subsequently use `getNetworkConfigFromName` - * to extract the network name from within the Autotask - * @param network - * @param contract - * @param name - name pre-encoding - * @returns - */ -export const encodeName = ( - network: NetworkConfig, - contract: "minter" | "exchange", - name: string, -) => `[${network.networkKey}][${contract}] ${name}`; - -export const decodeName = ( - encodedName: string, -): { networkKey: string; contract: string; name: string } => { - const regex = /^\[(.+)\]\[(.+)\]\s(.+)$/; - const match = encodedName.match(regex); - if (!match) { - throw new Error(`Invalid encoded name: ${encodedName}`); - } - const networkKey = match[1]; - const contract = match[2]; - const name = match[3]; - return { networkKey, contract, name }; -}; - -/** - * From an Autotask name, deduce which NetworkConfig we're using - * @param name - name post-encoding - */ -export const getNetworkConfigFromName = ( - name: string, -): NetworkConfig | undefined => { - const allNetworks = [...NETWORKS.TEST, ...NETWORKS.PROD]; - for (let i = 0; i < allNetworks.length; i++) { - const network = allNetworks[i]; - if (name.includes(`[${network.networkKey}]`)) { - return network; - } - } -}; diff --git a/defender/src/reset.ts b/defender/src/reset.ts deleted file mode 100644 index 010d86e1..00000000 --- a/defender/src/reset.ts +++ /dev/null @@ -1,24 +0,0 @@ -import config from "./config"; -import { AutotaskClient } from "@openzeppelin/defender-autotask-client"; -import { SentinelClient } from "@openzeppelin/defender-sentinel-client"; - -export const reset = async () => { - const autotaskClient = new AutotaskClient(config.credentials); - const sentinelClient = new SentinelClient(config.credentials); - - // Remove all old auto tasks and sentinels - const oldAutoTasks = await autotaskClient.list(); - const oldSentinels = await sentinelClient.list(); - return await Promise.all([ - ...oldAutoTasks.items.map((x) => - autotaskClient.delete(x.autotaskId).then((res) => { - console.log(res.message); - }), - ), - ...oldSentinels.items.map((x) => - sentinelClient.delete(x.subscriberId).then((res) => { - console.log(res.message); - }), - ), - ]); -}; diff --git a/defender/src/rollout.ts b/defender/src/rollout.ts deleted file mode 100644 index 3c68de16..00000000 --- a/defender/src/rollout.ts +++ /dev/null @@ -1,125 +0,0 @@ -import { createTask } from "./create-autotask"; -import { createSentinel } from "./create-sentinel"; -import { ApiError } from "./errors"; -import { NetworkConfig, encodeName } from "./networks"; -import { - HypercertExchangeAbi, - HypercertMinterAbi, -} from "@hypercerts-org/contracts"; - -export const rollOut = async (networks: NetworkConfig[]) => { - return await Promise.all( - networks.map(async (network) => { - // On allowlist created - const autoTaskOnAllowlistCreated = await createTask( - encodeName(network, "minter", "on-allowlist-created"), - "on-allowlist-created", - ); - if (!autoTaskOnAllowlistCreated) { - throw new ApiError( - encodeName( - network, - "minter", - "Could not create autoTask for on-allowlist-created", - ), - ); - } - await createSentinel({ - name: encodeName(network, "minter", "AllowlistCreated"), - network: network, - contractAddress: network.hypercertMinterContractAddress, - abi: HypercertMinterAbi, - eventConditions: [ - { eventSignature: "AllowlistCreated(uint256,bytes32)" }, - ], - autotaskID: autoTaskOnAllowlistCreated.autotaskId, - }); - - // On batch minted - const autoTaskOnBatchMintClaimsFromAllowlists = await createTask( - encodeName(network, "minter", "batch-mint-claims-from-allowlists"), - "batch-mint-claims-from-allowlists", - ); - if (!autoTaskOnBatchMintClaimsFromAllowlists) { - throw new ApiError( - encodeName( - network, - "minter", - "Could not create autoTask for batch-mint-claims-from-allowlists", - ), - ); - } - await createSentinel({ - name: encodeName(network, "minter", "batchMintClaimsFromAllowlists"), - network: network, - contractAddress: network.hypercertMinterContractAddress, - abi: HypercertMinterAbi, - autotaskID: autoTaskOnBatchMintClaimsFromAllowlists.autotaskId, - functionConditions: [ - { - functionSignature: - "batchMintClaimsFromAllowlists(address,bytes32[][],uint256[],uint256[])", - }, - ], - }); - - // On single minted from allowlist - const autoTaskOnMintClaimFromAllowlist = await createTask( - encodeName(network, "minter", "mint-claim-from-allowlist"), - "mint-claim-from-allowlist", - ); - if (!autoTaskOnMintClaimFromAllowlist) { - throw new ApiError( - encodeName( - network, - "minter", - "Could not create autoTask for mint-claim-from-allowlist", - ), - ); - } - await createSentinel({ - name: encodeName(network, "minter", "mintClaimFromAllowlist"), - network: network, - contractAddress: network.hypercertMinterContractAddress, - abi: HypercertMinterAbi, - autotaskID: autoTaskOnMintClaimFromAllowlist.autotaskId, - functionConditions: [ - { - functionSignature: - "mintClaimFromAllowlist(address,bytes32[],uint256,uint256)", - }, - ], - }); - - if (network.hypercertExchangeContractAddress) { - // On execute taker bid - const autoTaskExecuteTakerBid = await createTask( - encodeName(network, "exchange", "execute-taker-bid"), - "execute-taker-bid", - ); - if (!autoTaskExecuteTakerBid) { - throw new ApiError( - encodeName( - network, - "exchange", - "Could not create autoTask for execute-taker-bid", - ), - ); - } - await createSentinel({ - name: encodeName(network, "exchange", "executeTakerBid"), - network: network, - autotaskID: autoTaskExecuteTakerBid.autotaskId, - contractAddress: network.hypercertExchangeContractAddress, - abi: HypercertExchangeAbi, - functionConditions: [ - { - functionSignature: - "executeTakerBid((address,bytes),(uint8,uint256,uint256,uint256,uint256,uint8,address,address,address,uint256,uint256,uint256,uint256[],uint256[],bytes),bytes,(bytes32,(bytes32,uint8)[]))", - }, - ], - }); - } - }), - ); -}; diff --git a/defender/src/scripts/fix-allowlist-duplicates.ts b/defender/src/scripts/fix-allowlist-duplicates.ts deleted file mode 100644 index e22b1b3b..00000000 --- a/defender/src/scripts/fix-allowlist-duplicates.ts +++ /dev/null @@ -1,129 +0,0 @@ -// const supabaseLib = require("@supabase/supabase-js"); -// const dotenv = require("dotenv"); -// const _ = require("lodash"); -// import * as fetch from "node-fetch"; -// const hypercertsSDK = require("@hypercerts-org/hypercerts-sdk"); - -import { createClient } from "@supabase/supabase-js"; -import dotenv from "dotenv"; -import _ from "lodash"; -import fetch from "node-fetch"; - -const pageSize = 1000; - -dotenv.config(); -const supabase = createClient( - process.env.NEXT_PUBLIC_SUPABASE_HYPERCERTS_URL as string, - process.env.NEXT_PUBLIC_SUPABASE_HYPERCERTS_SERVICE_ROLE_KEY as string, -); - -const fetchAllowlistPage = async (lastId: number) => { - console.log("fetching page with id >", lastId); - return supabase - .from("allowlistCache-chainId") - .select("*") - .order("id", { ascending: true }) - .gt("id", lastId) - .eq("chainId", 10) - .limit(pageSize); -}; - -const deleteEntries = async (ids: number[]) => { - console.log("deleting entries", ids); - return supabase.from("allowlistCache-chainId").delete().in("id", ids); -}; - -const query = ` -query ClaimTokensByClaim($claimId: String!, $orderDirection: OrderDirection, $first: Int, $skip: Int) { - claimTokens(where: { claim: $claimId }, skip: $skip, first: $first, orderDirection: $orderDirection) { - id - owner - tokenID - units - } -} -`; - -const fetchClaimTokenForClaimId = async (claimId: string) => { - return ( - fetch( - "https://api.thegraph.com/subgraphs/name/hypercerts-admin/hypercerts-optimism-mainnet", - { - method: "POST", - headers: { - "Content-Type": "application/json", - }, - body: JSON.stringify({ - variables: { - claimId, - first: 1000, - }, - query, - }), - }, - ) - .then((res) => res.json()) - // eslint-disable-next-line @typescript-eslint/ban-ts-comment - // @ts-ignore - .then((res) => res.data?.claimTokens) - ); -}; - -const main = async () => { - const totalNumberOfResults = await supabase - .from("allowlistCache-chainId") - .select("id", { count: "exact" }); - - console.log("totalNumberOfResults", totalNumberOfResults.count); - - let lastId = 1; - - // Iterate over all pages - // eslint-disable-next-line no-constant-condition - while (true) { - const { data } = await fetchAllowlistPage(lastId); - if (data.length === 0) { - break; - } - lastId = data[data.length - 1].id; - - const allowlistEntriesByClaimId = _.groupBy(data, "claimId"); - // console.log("fetched page", i); - - for (const claimId in allowlistEntriesByClaimId) { - // console.log("checking duplicates for", claimId); - const entries = allowlistEntriesByClaimId[claimId]; - // console.log(entries.length, "entries found"); - - const tokensForClaim = await fetchClaimTokenForClaimId(claimId); - // console.log("tokensForClaim", tokensForClaim); - - const addressesForClaimTokens = tokensForClaim.map( - // eslint-disable-next-line @typescript-eslint/no-explicit-any - (token: any) => token.owner, - ); - const addressesForEntry = entries.map((x) => x.address); - // console.log("Addresses for claim tokens", addressesForClaimTokens); - // console.log("Addresses for entries", addressesForEntry); - - const duplicates = _.intersectionBy( - addressesForClaimTokens, - addressesForEntry, - ); - - if (duplicates.length > 0) { - const supabaseEntries = entries.filter((entry) => - duplicates.includes(entry.address), - ); - // console.log("duplicates found for claimId", claimId, duplicates.length); - // console.log("duplicates", duplicates); - // console.log("duplicate supabaseEntries", supabaseEntries); - const idsToDelete = supabaseEntries.map((x) => x.id); - await deleteEntries(idsToDelete); - } - } - } -}; - -// eslint-disable-next-line @typescript-eslint/no-floating-promises -main(); diff --git a/defender/src/setup.ts b/defender/src/setup.ts deleted file mode 100644 index 61fb2f9e..00000000 --- a/defender/src/setup.ts +++ /dev/null @@ -1,70 +0,0 @@ -import config from "./config"; -import { ApiError, ConfigError } from "./errors"; -import { NETWORKS, getNetworkConfigFromName } from "./networks"; -import { reset } from "./reset"; -import { rollOut } from "./rollout"; -import { updateAutotask, updateSentinel } from "./update"; -import { AutotaskClient } from "@openzeppelin/defender-autotask-client"; -import { SentinelClient } from "@openzeppelin/defender-sentinel-client"; - -const setup = async () => { - const args = process.argv.slice(2); - if (args.length < 1) { - throw new ApiError("Missing argument: "); - } - - const environment = args[0]; - const supportedEnv = Object.keys(NETWORKS); - - if (!supportedEnv.includes(environment)) { - throw new ApiError("Invalid environment: "); - } - - const networks = config.networks[environment as keyof typeof NETWORKS]; - - const autotaskClient = new AutotaskClient(config.credentials); - const sentinelClient = new SentinelClient(config.credentials); - - // Remove all old auto tasks and sentinels - const oldAutoTasks = await autotaskClient.list(); - const oldSentinels = await sentinelClient.list(); - - const networksDeployed = oldAutoTasks.items - .map((task) => getNetworkConfigFromName(task.name).chainId) - .filter((value, index, array) => array.indexOf(value) === index); - - const missingNetworks = networks.filter( - (network) => !networksDeployed.includes(network.chainId), - ); - - if (missingNetworks.length > 0) { - await rollOut(missingNetworks); - } - - let updates = false; - - if (oldAutoTasks.items.length > 0) { - updates = true; - await updateAutotask(networks); - } - - if (oldSentinels.items.length > 0) { - updates = true; - await updateSentinel(networks); - } - - if (!updates) { - // Delete all sentinels and tasks first - await reset(); - - // Error out if no networks configured. - if (networks.length < 1) { - throw new ConfigError("No networks specified"); - } - - await rollOut(networks); - } -}; - -//eslint-disable-next-line @typescript-eslint/no-floating-promises -setup(); diff --git a/defender/src/update.ts b/defender/src/update.ts deleted file mode 100644 index 1a06d6e7..00000000 --- a/defender/src/update.ts +++ /dev/null @@ -1,106 +0,0 @@ -import { abi as HypercertMinterAbi } from "./HypercertMinterABI"; -import config from "./config"; -import { NetworkConfig, decodeName } from "./networks"; -import { AutotaskClient } from "@openzeppelin/defender-autotask-client"; -import { SentinelClient } from "@openzeppelin/defender-sentinel-client"; -import { HypercertExchangeAbi } from "@hypercerts-org/contracts"; - -export const updateAutotask = async (networks: NetworkConfig[]) => { - const autotaskClient = new AutotaskClient(config.credentials); - const targetNetworks = networks.map((network) => network.networkKey); - - const oldAutoTasks = await autotaskClient.list(); - - return await Promise.all([ - ...oldAutoTasks.items.map((autoTask) => { - // Get name and network - const { name, networkKey } = decodeName(autoTask.name); - - // Validate if in target networks - if (!targetNetworks.includes(networkKey as NetworkConfig["networkKey"])) { - return; - } - - // Update autotask - console.log( - `Updating ${autoTask.autotaskId} from ./build/relay/${name} on ${networkKey}`, - ); - - autotaskClient - .updateCodeFromFolder(autoTask.autotaskId, `./build/relay/${name}`) - .then((res) => { - console.log(`Updated ${autoTask.autotaskId}`); - console.log(res); - }) - .catch((err) => { - console.error(`Failed to update ${autoTask.autotaskId}`); - console.error(err); - }); - }), - ]); -}; - -export const updateSentinel = async (networks: NetworkConfig[]) => { - const sentinelClient = new SentinelClient(config.credentials); - const targetNetworks = networks.map((network) => network.networkKey); - - const oldSentinels = await sentinelClient.list(); - - return await Promise.all([ - ...oldSentinels.items.map((sentinel) => { - // Get name and network - const { name, networkKey, contract } = decodeName(sentinel.name); - - // Validate if in target networks - - let address: string | undefined; - let abi: any; - - if (!targetNetworks.includes(networkKey as NetworkConfig["networkKey"])) { - return; - } - const network = networks.find( - (network) => network.networkKey === networkKey, - ); - - if (contract === "minter") { - address = network?.hypercertMinterContractAddress; - abi = HypercertMinterAbi; - } - - if (contract === "exchange") { - address = network?.hypercertExchangeContractAddress; - abi = HypercertExchangeAbi; - } - - if (!address) { - console.error(`No address found for ${sentinel.subscriberId}`); - return; - } - if (!abi) { - console.error(`No abi found for ${sentinel.subscriberId}`); - return; - } - - // Update sentinel - console.log( - `Updating ${sentinel.subscriberId} from ./build/relay/${name} on ${networkKey}`, - ); - - sentinelClient - .update(sentinel.subscriberId, { - ...sentinel, - addresses: [address], - abi, - }) - .then((res) => { - console.log(`Updated: ", ${sentinel.subscriberId}`); - console.log(res); - }) - .catch((err) => { - console.error(`Failed to update ${sentinel.subscriberId}`); - console.error(err); - }); - }), - ]); -}; diff --git a/defender/tsconfig.json b/defender/tsconfig.json deleted file mode 100644 index 7a1fd6c3..00000000 --- a/defender/tsconfig.json +++ /dev/null @@ -1,25 +0,0 @@ -{ - "compilerOptions": { - "allowJs": true, - "allowSyntheticDefaultImports": true, - "declaration": false, - "declarationMap": false, - "downlevelIteration": true, - "emitDecoratorMetadata": true, - "esModuleInterop": true, - "experimentalDecorators": true, - "forceConsistentCasingInFileNames": true, - "lib": ["es6"], - "module": "ESNext", - "moduleResolution": "node", - "noImplicitAny": true, - "removeComments": true, - "resolveJsonModule": true, - "skipLibCheck": true, - "sourceMap": false, - "strict": false, - "target": "es6" - }, - "exclude": ["node_modules"], - "include": ["src/**/*"] -} diff --git a/defender/webpack.config.cjs b/defender/webpack.config.cjs deleted file mode 100644 index 749abaf2..00000000 --- a/defender/webpack.config.cjs +++ /dev/null @@ -1,50 +0,0 @@ -const path = require("path"); -const webpack = require("webpack"); -const TerserPlugin = require("terser-webpack-plugin"); - -module.exports = { - entry: { - "batch-mint-claims-from-allowlists": - "./src/auto-tasks/batch-mint-claims-from-allowlists.ts", - "on-allowlist-created": "./src/auto-tasks/on-allowlist-created.ts", - "mint-claim-from-allowlist": - "./src/auto-tasks/mint-claim-from-allowlist.ts", - "execute-taker-bid": - "./src/auto-tasks/execute-taker-bid.ts", - }, - target: "node", - mode: "development", - devtool: "cheap-module-source-map", - module: { - rules: [{ test: /\.tsx?$/, use: "ts-loader", exclude: /node_modules/ }], - }, - resolve: { - extensions: [".ts", ".js"], - }, - externals: [ - // List here all dependencies available on the Autotask environment - /axios/, - /apollo-client/, - /defender-[^\-]+-client/, - /ethers/, - /web3/, - /@ethersproject\/.*/, - /aws-sdk/, - /aws-sdk\/.*/, - ], - externalsType: "commonjs2", - plugins: [ - // List here all dependencies that are not run in the Autotask environment - new webpack.IgnorePlugin({ resourceRegExp: /dotenv/ }), - ], - optimization: { - minimize: true, - minimizer: [new TerserPlugin()], - }, - output: { - filename: "[name]/index.js", - path: path.resolve(__dirname, "build", "relay"), - sourceMapFilename: "[file].map", - library: { type: "commonjs2" }, - }, -}; diff --git a/docker/README.md b/docker/README.md deleted file mode 100644 index 8366923c..00000000 --- a/docker/README.md +++ /dev/null @@ -1,15 +0,0 @@ -# Docker Setup for E2E Suite - -This docker setup is intended to be used as both a test harness and also as -local development infrastructure to enable fast-as-possible iteration. - -For more docs on usage, see the root README in this monorepo. - -## Multi-arch building - -Eventually this will be put into our github actions but for now here are the -instructions for a multi-arch build (some of us have arm chips afterall). - -``` -docker buildx create --name dual_arm64_amd64 --platform linux/amd64,linux/arm/v8 -``` diff --git a/docker/after_graph.sh b/docker/after_graph.sh deleted file mode 100644 index 625085bd..00000000 --- a/docker/after_graph.sh +++ /dev/null @@ -1,26 +0,0 @@ -#!/bin/bash - -# Script to run after the graph has started running - -set -euxo pipefail - -# Load application environment variables -source /usr/src/app/node_modules/app.env.sh - -export GRAPH_RPC_URL=$DOCKER_INTERNAL_GRAPH_RPC_URL -export IPFS_URL=$DOCKER_INTERNAL_IPFS_URL -export SUBGRAPH_NAME=hypercerts-admin/hypercerts-hardhat -export SUBGRAPH_MANIFEST=.test.subgraph.yaml -export VERSION_LABEL=v0.0.1 - -echo "Deploying the subgraph" - -cd "$REPO_DIR/graph" - -cat subgraph.yaml | sed 's/network: .*/network: hardhat/;s/address: ".*"/address: "'"${NEXT_PUBLIC_CONTRACT_ADDRESS}"'"/;s/startBlock: .*/startBlock: '"${CONTRACT_DEPLOYED_BLOCK_NUMBER}"'/' > $SUBGRAPH_MANIFEST -prepend_text="# This file is generated for local testing. It should not be committed" - -printf '%s\n%s\n' "${prepend_text}" "$(cat $SUBGRAPH_MANIFEST)" > $SUBGRAPH_MANIFEST - -yarn graph create --node $GRAPH_RPC_URL $SUBGRAPH_NAME -yarn graph deploy --node $GRAPH_RPC_URL --ipfs $IPFS_URL --version-label=$VERSION_LABEL $SUBGRAPH_NAME $SUBGRAPH_MANIFEST \ No newline at end of file diff --git a/docker/after_localchain.sh b/docker/after_localchain.sh deleted file mode 100644 index dc7acc75..00000000 --- a/docker/after_localchain.sh +++ /dev/null @@ -1,108 +0,0 @@ -#!/bin/bash -set -euxo pipefail - -# Reinitializes a test harness that can be used for local development or end to -# end testing with playwright - -REPO_DIR=${REPO_DIR:-} -LOCAL_TESTING_ADDRESS=${LOCAL_TESTING_ADDRESS:-} -deploy_json=/deploy.json - -export LOCALHOST_NETWORK_URL=http://localchain:8545 -export NEXT_PUBLIC_DEFAULT_CHAIN_ID=31337 - -function hardhat_local() { - yarn hardhat --network localhost $@ -} - -# Clean up stateful data related to any previous invocation of this -# docker-compose setup -rm -rf /postgres/* -rm -rf /ipfs_staging/* -rm -rf /ipfs_data/* - -# Allow passing in the repo directory. Otherwise automagically get the correct -# directory based on this script's path -if [[ -z "${REPO_DIR}" ]]; then - # Ensure we're working from the script's directory. This is a bit brittle but - # it's intended to be bespoke to this repo - script_dir=$( cd -- "$( dirname -- "${BASH_SOURCE[0]}" )" &> /dev/null && pwd ) - cd "$script_dir"/.. - REPO_DIR=$( pwd ) -fi - -# Rebuild the project if necessary -# TODO this is failing in docker. Need to figure out why. Probably dude to shared vms -cd "${REPO_DIR}" -yarn build:contracts -yarn build:defender -yarn build:graph -yarn build:sdk - -cd "${REPO_DIR}/contracts" - -# Deploy the contract -echo "Deploy the contract" -hardhat_local deploy --output "$deploy_json" - -# Transfer token to a specific account if that account has been specified -if [[ ! -z "${LOCAL_TESTING_ADDRESS}" ]]; then - echo "Funding ${LOCAL_TESTING_ADDRESS}" - hardhat_local transfer-from-test-account --dest "$LOCAL_TESTING_ADDRESS" --amount 5000 -fi - -contract_address=$(jq '.address' -r "$deploy_json") -contract_deployed_block_number=$(jq '.blockNumber' -r "$deploy_json") -echo "Contract address to be loaded: $contract_address" - -# Have these here so we can do some interpolating -GRAPH_BASE_URL=http://${FRONTEND_GRAPH_HOST}:${FRONTEND_GRAPH_HTTP_PORT}/subgraphs/name -GRAPH_NAME=hypercerts-hardhat -GRAPH_NAMESPACE=hypercerts-admin -NEXT_PUBLIC_GRAPH_URL=${GRAPH_BASE_URL}/${GRAPH_NAMESPACE}/${GRAPH_NAME} - -cat < /usr/src/app/node_modules/app.env.sh -# Generate an environment file from the contract deployment -export REPO_DIR=${REPO_DIR} -export NEXT_PUBLIC_DEFAULT_CHAIN_ID=31337 -export NEXT_PUBLIC_CHAIN_NAME=hardhat -export NEXT_PUBLIC_CONTRACT_ADDRESS="${contract_address}" -export CONTRACT_DEPLOYED_BLOCK_NUMBER="${contract_deployed_block_number}" -export NEXT_PUBLIC_UNSAFE_FORCE_OVERRIDE_CONFIG=1 -export NEXT_PUBLIC_RPC_URL=http://${FRONTEND_RPC_HOST}:${FRONTEND_RPC_PORT} -export FRONTEND_RPC_PORT=${FRONTEND_RPC_PORT} -export FRONTEND_RPC_HOST=${FRONTEND_RPC_HOST} -export FRONTEND_GRAPH_HOST=${FRONTEND_GRAPH_HOST} -export FRONTEND_GRAPH_HTTP_PORT=${FRONTEND_GRAPH_HTTP_PORT} -export FRONTEND_GRAPH_WS_PORT=${FRONTEND_GRAPH_WS_PORT} -export FRONTEND_GRAPH_JSON_RPC_PORT=${FRONTEND_GRAPH_JSON_RPC_PORT} -export FRONTEND_GRAPH_INDEX_STATUS_PORT=${FRONTEND_GRAPH_INDEX_STATUS_PORT} -export FRONTEND_IPFS_HOST=${FRONTEND_IPFS_HOST} -export FRONTEND_IPFS_LIBP2P_PORT=${FRONTEND_IPFS_LIBP2P_PORT} -export FRONTEND_IPFS_API_PORT=${FRONTEND_IPFS_API_PORT} -export FRONTEND_IPFS_GATEWAY_PORT=${FRONTEND_IPFS_GATEWAY_PORT} -export FRONTEND_PORT=${FRONTEND_PORT} -export FRONTEND_HOST=${FRONTEND_HOST} - -export NEXT_PUBLIC_GRAPH_URL=${NEXT_PUBLIC_GRAPH_URL} - -export DOCKER_INTERNAL_GRAPH_RPC_URL=http://graph:8020 -export DOCKER_INTERNAL_GRAPH_HTTP_URL=http://graph:8000 -export DOCKER_INTERNAL_IPFS_URL=http://ipfs:5001 -export PLASMIC_PROJECT_ID="$PLASMIC_PROJECT_ID" -export PLASMIC_PROJECT_API_TOKEN="$PLASMIC_PROJECT_API_TOKEN" -export LOCALHOST_NETWORK_URL=${LOCALHOST_NETWORK_URL} -export NEXT_PUBLIC_NFT_STORAGE_TOKEN=${NEXT_PUBLIC_NFT_STORAGE_TOKEN} -export NEXT_PUBLIC_WEB3_STORAGE_TOKEN=${NEXT_PUBLIC_WEB3_STORAGE_TOKEN} -export NEXT_PUBLIC_WALLETCONNECT_ID=${NEXT_PUBLIC_WALLETCONNECT_ID} -export NEXT_PUBLIC_DOMAIN=${NEXT_PUBLIC_DOMAIN} -export NEXT_PUBLIC_SUPABASE_URL=${NEXT_PUBLIC_SUPABASE_URL} -export NEXT_PUBLIC_SUPABASE_ANON_KEY=${NEXT_PUBLIC_SUPABASE_ANON_KEY} -export NEXT_PUBLIC_SUPABASE_TABLE=${NEXT_PUBLIC_SUPABASE_TABLE} -EOF - -source /usr/src/app/node_modules/app.env.sh - -cd $REPO_DIR -# Run a full build (this seems to be necessary) -yarn build \ No newline at end of file diff --git a/docker/base.Dockerfile b/docker/base.Dockerfile deleted file mode 100644 index f178663a..00000000 --- a/docker/base.Dockerfile +++ /dev/null @@ -1,5 +0,0 @@ -FROM node:18 - -RUN apt-get update \ - && apt-get install -y jq \ - && npm install -g @graphprotocol/graph-cli diff --git a/docker/base.env b/docker/base.env deleted file mode 100644 index 078e078f..00000000 --- a/docker/base.env +++ /dev/null @@ -1,4 +0,0 @@ -# VERSIONS FOR DOCKER IMAGES -GRAPH_NODE_DEV_VERSION=6f907fcb75f23a3b3ed27dde0cb1eb3758a09ec3 -NODE_DEV_VERSION=1.0 -PLAYWRIGHT_VERSION=v1.35.0 \ No newline at end of file diff --git a/docker/compose.yaml b/docker/compose.yaml deleted file mode 100644 index ef7b15f4..00000000 --- a/docker/compose.yaml +++ /dev/null @@ -1,249 +0,0 @@ -version: '3' - -volumes: - node_modules: - graph_modules: - sdk_modules: - contracts_modules: - postgres_storage: - ipfs_staging: - ipfs_data: - subgraph.yaml: - - -services: - install: - image: ghcr.io/hypercerts-org/node-dev-18:1.0-${DOCKER_PLATFORM:-amd64} - working_dir: /usr/src/app - command: bash docker/install.sh - volumes: - - ../:/usr/src/app - - node_modules:/usr/src/app/node_modules - - sdk_modules:/usr/src/app/sdk/node_modules - - contracts_modules:/usr/src/app/contracts/node_modules - - graph_modules:/usr/src/app/graph/node_modules - localchain: - image: ghcr.io/hypercerts-org/node-dev-18:1.0-${DOCKER_PLATFORM:-amd64} - ports: - - "${FRONTEND_RPC_PORT}:8545" - working_dir: /usr/src/app/contracts - command: yarn hardhat node - depends_on: - install: - condition: service_completed_successfully - healthcheck: - test: [ "CMD", "curl", "-f", "http://localhost:8545" ] - interval: 1s - timeout: 15s - retries: 5 - start_period: 30s - volumes: - - ../:/usr/src/app - - node_modules:/usr/src/app/node_modules - - sdk_modules:/usr/src/app/sdk/node_modules - - contracts_modules:/usr/src/app/contracts/node_modules - - graph_modules:/usr/src/app/graph/node_modules - after_localchain: - image: ghcr.io/hypercerts-org/node-dev-18:1.0-${DOCKER_PLATFORM:-amd64} - working_dir: /usr/src/app - command: bash docker/after_localchain.sh - depends_on: - localchain: - condition: service_healthy - environment: - - PLASMIC_PROJECT_ID=${PLASMIC_PROJECT_ID} - - PLASMIC_PROJECT_API_TOKEN=${PLASMIC_PROJECT_API_TOKEN} - - LOCAL_TESTING_ADDRESS=${LOCAL_TESTING_ADDRESS} - - FRONTEND_RPC_PORT=${FRONTEND_RPC_PORT} - - FRONTEND_RPC_HOST=${FRONTEND_RPC_HOST} - - FRONTEND_GRAPH_HOST=${FRONTEND_GRAPH_HOST} - - FRONTEND_GRAPH_HTTP_PORT=${FRONTEND_GRAPH_HTTP_PORT} - - FRONTEND_GRAPH_WS_PORT=${FRONTEND_GRAPH_WS_PORT} - - FRONTEND_GRAPH_JSON_RPC_PORT=${FRONTEND_GRAPH_JSON_RPC_PORT} - - FRONTEND_GRAPH_INDEX_STATUS_PORT=${FRONTEND_GRAPH_INDEX_STATUS_PORT} - - FRONTEND_IPFS_HOST=${FRONTEND_IPFS_HOST} - - FRONTEND_IPFS_LIBP2P_PORT=${FRONTEND_IPFS_LIBP2P_PORT} - - FRONTEND_IPFS_API_PORT=${FRONTEND_IPFS_API_PORT} - - FRONTEND_IPFS_GATEWAY_PORT=${FRONTEND_IPFS_GATEWAY_PORT} - - FRONTEND_PORT=${FRONTEND_PORT} - - FRONTEND_HOST=${FRONTEND_HOST} - - NEXT_PUBLIC_NFT_STORAGE_TOKEN=${NEXT_PUBLIC_NFT_STORAGE_TOKEN} - - NEXT_PUBLIC_WEB3_STORAGE_TOKEN=${NEXT_PUBLIC_WEB3_STORAGE_TOKEN} - - NEXT_PUBLIC_WALLETCONNECT_ID=${NEXT_PUBLIC_WALLETCONNECT_ID} - - NEXT_PUBLIC_DOMAIN=${NEXT_PUBLIC_DOMAIN} - - NEXT_PUBLIC_SUPABASE_URL=${NEXT_PUBLIC_SUPABASE_URL} - - NEXT_PUBLIC_SUPABASE_ANON_KEY=${NEXT_PUBLIC_SUPABASE_ANON_KEY} - - NEXT_PUBLIC_SUPABASE_TABLE=${NEXT_PUBLIC_SUPABASE_TABLE} - volumes: - - ../:/usr/src/app - - node_modules:/usr/src/app/node_modules - - sdk_modules:/usr/src/app/sdk/node_modules - - contracts_modules:/usr/src/app/contracts/node_modules - - graph_modules:/usr/src/app/graph/node_modules - - postgres_storage:/postgres - - ipfs_staging:/ipfs_staging - - ipfs_data:/ipfs_data - tx_client: - image: ghcr.io/hypercerts-org/node-dev-18:${NODE_DEV_VERSION}-${DOCKER_PLATFORM:-amd64} - working_dir: /usr/src/app - command: docker/tx_client.sh - depends_on: - after_graph: - condition: service_completed_successfully - volumes: - - ../:/usr/src/app - - node_modules:/usr/src/app/node_modules - - sdk_modules:/usr/src/app/sdk/node_modules - - contracts_modules:/usr/src/app/contracts/node_modules - - graph_modules:/usr/src/app/graph/node_modules - restart: on-failure - frontend: - profiles: - - testing - image: ghcr.io/hypercerts-org/node-dev-18:${NODE_DEV_VERSION}-${DOCKER_PLATFORM:-amd64} - privileged: true - working_dir: /usr/src/app - ports: - - "${FRONTEND_PORT}:3000" - command: bash docker/frontend.sh - depends_on: - after_localchain: - condition: service_completed_successfully - after_graph: - condition: service_completed_successfully - volumes: - - ../:/usr/src/app - - node_modules:/usr/src/app/node_modules - - sdk_modules:/usr/src/app/sdk/node_modules - - contracts_modules:/usr/src/app/contracts/node_modules - - graph_modules:/usr/src/app/graph/node_modules - environment: - - ENVIRONMENT=${ENVIRONMENT} - healthcheck: - test: [ "CMD", "curl", "-f", "http://localhost:3000" ] - interval: 1s - timeout: 15s - retries: 30 - start_period: 100s - ipfs: - image: ipfs/kubo - command: daemon --offline --migrate=true --agent-version-suffix=docker - depends_on: - after_localchain: - condition: service_completed_successfully - ports: - - "${FRONTEND_IPFS_GATEWAY_PORT}:8080" - - "${FRONTEND_IPFS_API_PORT}:5001" - # Don't need to expose the libp2p port at this time. - # - "${IPFS_LIBP2P_PORT}:4001" - volumes: - - ipfs_staging:/export - - ipfs_data:/data/ipfs - postgres: - image: postgres:15 - restart: always - user: postgres - depends_on: - after_localchain: - condition: service_completed_successfully - # Required command for the graph - command: - [ - "postgres", - "-cshared_preload_libraries=pg_stat_statements" - ] - volumes: - - postgres_storage:/var/lib/postgresql/data - - ./postgres.init.d:/docker-entrypoint-initdb.d - environment: - POSTGRES_USER: postgres - POSTGRES_PASSWORD: postgres - POSTGRES_DB: graph-node - POSTGRES_INITDB_ARGS: "-E UTF8 --locale=C" - healthcheck: - test: [ "CMD-SHELL", "pg_isready" ] - interval: 10s - timeout: 5s - retries: 5 - graph: - image: ghcr.io/hypercerts-org/graph-node-dev:${GRAPH_NODE_DEV_VERSION}-${DOCKER_PLATFORM:-amd64} - depends_on: - postgres: - condition: service_healthy - localchain: - condition: service_healthy - ipfs: - condition: service_started - privileged: true - environment: - postgres_host: postgres - postgres_port: 5432 - postgres_user: postgres - postgres_pass: postgres - postgres_db: graph - ipfs: ipfs:5001 - ethereum: hardhat:http://localchain:8545 - ports: - # WS - - "${FRONTEND_GRAPH_WS_PORT}:8001" - # JSON-RPC - - "${FRONTEND_GRAPH_JSON_RPC_PORT}:8020" - # Indexing status - - "${FRONTEND_GRAPH_INDEX_STATUS_PORT}:8030" - healthcheck: - test: [ "CMD", "curl", "-f", "http://localhost:8000" ] - interval: 5s - timeout: 5s - retries: 10 - start_period: 30s - graph_proxy: - # This proxy is required to fix some CORS issues with the graph - image: nginx - volumes: - - ./nginx/graph_nginx.conf:/etc/nginx/nginx.conf - depends_on: - graph: - condition: service_healthy - ports: - - "${FRONTEND_GRAPH_HTTP_PORT}:80" - after_graph: - image: ghcr.io/hypercerts-org/node-dev-18:${NODE_DEV_VERSION}-${DOCKER_PLATFORM:-amd64} - depends_on: - graph: - condition: service_healthy - working_dir: /usr/src/app - privileged: true - command: bash docker/after_graph.sh - volumes: - - ../:/usr/src/app - - node_modules:/usr/src/app/node_modules - - sdk_modules:/usr/src/app/sdk/node_modules - - contracts_modules:/usr/src/app/contracts/node_modules - - graph_modules:/usr/src/app/graph/node_modules - playwright: - image: ghcr.io/hypercerts-org/playwright:v1.35.0-amd64 - working_dir: /usr/src/app - command: docker/run_tests.sh - privileged: true - depends_on: - after_graph: - condition: service_completed_successfully - tx_client: - condition: service_started - frontend: - condition: service_healthy - environment: - - CI=${CI} - - DEBIAN_FRONTEND=noninteractive - - ENABLE_VNC=${ENABLE_VNC} - profiles: - - testing - ports: - - 5900:5900 - volumes: - - ./nginx/e2e_proxy.conf:/etc/nginx/e2e_proxy.conf - - ../:/usr/src/app - - node_modules:/usr/src/app/node_modules - - sdk_modules:/usr/src/app/sdk/node_modules - - contracts_modules:/usr/src/app/contracts/node_modules - - graph_modules:/usr/src/app/graph/node_modules diff --git a/docker/dev.env b/docker/dev.env deleted file mode 100644 index 6f8efacb..00000000 --- a/docker/dev.env +++ /dev/null @@ -1,26 +0,0 @@ -# Environment vars in the style `FRONTEND_*` are specifically for use when # -# when accessing a service from the frontend application (browserland). - -# Graph related ports -FRONTEND_GRAPH_HOST=localhost -FRONTEND_GRAPH_HTTP_PORT=8000 -FRONTEND_GRAPH_WS_PORT=8001 -FRONTEND_GRAPH_JSON_RPC_PORT=8020 -FRONTEND_GRAPH_INDEX_STATUS_PORT=8030 - -# IPFS Related ports -FRONTEND_IPFS_HOST=localhost -FRONTEND_IPFS_LIBP2P_PORT=4001 -FRONTEND_IPFS_API_PORT=5001 -FRONTEND_IPFS_GATEWAY_PORT=8080 - -# ETH JSON RPC Port -FRONTEND_RPC_HOST=localhost -FRONTEND_RPC_PORT=8545 - -# Hypercerts Dapp Frontend Port -FRONTEND_PORT=3000 -FRONTEND_HOST=127.0.0.1 -NEXT_PUBLIC_DOMAIN=localhost - -ENVIRONMENT=development diff --git a/docker/e2e.env b/docker/e2e.env deleted file mode 100644 index 11219dfc..00000000 --- a/docker/e2e.env +++ /dev/null @@ -1,24 +0,0 @@ -# Graph related ports -FRONTEND_GRAPH_HOST=graph -FRONTEND_GRAPH_HTTP_PORT=8000 -FRONTEND_GRAPH_WS_PORT=8001 -FRONTEND_GRAPH_JSON_RPC_PORT=8020 -FRONTEND_GRAPH_INDEX_STATUS_PORT=8030 - -# IPFS Related ports -FRONTEND_IPFS_HOST=ipfs -FRONTEND_IPFS_LIBP2P_PORT=4001 -FRONTEND_IPFS_API_PORT=5001 -FRONTEND_IPFS_GATEWAY_PORT=8080 - -# ETH JSON RPC Port -FRONTEND_RPC_HOST=127.0.0.1 -FRONTEND_RPC_PORT=8545 - -# Hypercerts Dapp Frontend Port -FRONTEND_PORT=3000 -FRONTEND_HOST=127.0.0.1 -NEXT_PUBLIC_DEFAULT_CHAIN_ID=31337 -NEXT_PUBLIC_DOMAIN=localhost - -ENVIRONMENT=tests diff --git a/docker/frontend.sh b/docker/frontend.sh deleted file mode 100644 index de130cc2..00000000 --- a/docker/frontend.sh +++ /dev/null @@ -1,15 +0,0 @@ -#!/bin/bash -set -euo pipefail - -source /usr/src/app/node_modules/app.env.sh - -cd "${REPO_DIR}/frontend" - -if [[ "$ENVIRONMENT" == "tests" ]]; then - echo "Building a production-like environment for testing" - yarn build - yarn start -else - echo "Running the dev environment" - yarn dev -fi diff --git a/docker/graph.Dockerfile b/docker/graph.Dockerfile deleted file mode 100644 index c441a26c..00000000 --- a/docker/graph.Dockerfile +++ /dev/null @@ -1,9 +0,0 @@ -ARG DOCKER_PLATFORM=amd64 -ARG GRAPH_COMMIT_SHA - -# In order to support multiple development environments we use a custom base -# node built from the graph node repo -# See: https://github.com/graphprotocol/graph-node -FROM ghcr.io/hypercerts-org/graph-node:${GRAPH_COMMIT_SHA}-${DOCKER_PLATFORM} - -RUN apt-get update && apt-get install -y curl diff --git a/docker/install.sh b/docker/install.sh deleted file mode 100644 index eb2cfce4..00000000 --- a/docker/install.sh +++ /dev/null @@ -1,4 +0,0 @@ -#!/bin/bash - -git config --global --add safe.directory /usr/src/app -yarn install --non-interactive --frozen-lockfile \ No newline at end of file diff --git a/docker/nginx/e2e_proxy.conf b/docker/nginx/e2e_proxy.conf deleted file mode 100644 index 44aa87ce..00000000 --- a/docker/nginx/e2e_proxy.conf +++ /dev/null @@ -1,71 +0,0 @@ -worker_processes 2; -daemon on; - -events { - use epoll; - worker_connections 128; -} - -http { - # Hardhat needs to be "127.0.0.1" for it to work properly - server { - listen 8545; - server_name localhost; - location / { - if ($request_method = 'OPTIONS') { - add_header 'Access-Control-Allow-Origin' '*'; - add_header 'Access-Control-Allow-Methods' '*'; - add_header 'Access-Control-Allow-Headers' '*'; - add_header 'Access-Control-Max-Age' 1728000; - add_header 'Content-Type' 'text/plain; charset=utf-8'; - add_header 'Content-Length' 0; - return 204; - } - proxy_pass http://localchain:8545/; - } - } - - # Proxy the graph - server { - listen 8000; - server_name localhost; - location / { - if ($request_method = 'OPTIONS') { - add_header 'Access-Control-Allow-Origin' '*'; - add_header 'Access-Control-Allow-Methods' '*'; - add_header 'Access-Control-Allow-Headers' '*'; - add_header 'Access-Control-Max-Age' 1728000; - add_header 'Content-Type' 'text/plain; charset=utf-8'; - add_header 'Content-Length' 0; - return 204; - } - proxy_pass http://graph:8000/; - } - } - - # Proxy ipfs (don't think this is necessary) - server { - listen 8080; - server_name localhost; - location / { - if ($request_method = 'OPTIONS') { - add_header 'Access-Control-Allow-Origin' '*'; - add_header 'Access-Control-Allow-Methods' '*'; - add_header 'Access-Control-Allow-Headers' '*'; - add_header 'Access-Control-Max-Age' 1728000; - add_header 'Content-Type' 'text/plain; charset=utf-8'; - add_header 'Content-Length' 0; - return 204; - } - proxy_pass http://ipfs:8080/; - } - } - - server { - listen 3000; - server_name localhost; - location / { - proxy_pass http://frontend:3000/; - } - } -} diff --git a/docker/nginx/graph_nginx.conf b/docker/nginx/graph_nginx.conf deleted file mode 100644 index 3b6400fd..00000000 --- a/docker/nginx/graph_nginx.conf +++ /dev/null @@ -1,25 +0,0 @@ -worker_processes 2; - -events { - use epoll; - worker_connections 128; -} - -http { - server { - listen 80; - server_name localhost; - location / { - if ($request_method = 'OPTIONS') { - add_header 'Access-Control-Allow-Origin' '*'; - add_header 'Access-Control-Allow-Methods' '*'; - add_header 'Access-Control-Allow-Headers' '*'; - add_header 'Access-Control-Max-Age' 1728000; - add_header 'Content-Type' 'text/plain; charset=utf-8'; - add_header 'Content-Length' 0; - return 204; - } - proxy_pass http://graph:8000/; - } - } -} diff --git a/docker/playwright.Dockerfile b/docker/playwright.Dockerfile deleted file mode 100644 index e9fdc7a6..00000000 --- a/docker/playwright.Dockerfile +++ /dev/null @@ -1,7 +0,0 @@ -FROM mcr.microsoft.com/playwright:v1.35.0-jammy - -ARG DEBIAN_FRONTEND=noninteractive -ENV TZ=UTC - -RUN apt-get update && \ - apt-get install -y xvfb fluxbox x11vnc nginx \ No newline at end of file diff --git a/docker/postgres.init.d/add_databases.sh b/docker/postgres.init.d/add_databases.sh deleted file mode 100755 index 32f63b5d..00000000 --- a/docker/postgres.init.d/add_databases.sh +++ /dev/null @@ -1,8 +0,0 @@ -#!/bin/bash -set -e - -psql -v ON_ERROR_STOP=1 --username "$POSTGRES_USER" --dbname "$POSTGRES_DB" <<-EOSQL - CREATE DATABASE graph; -EOSQL - -echo "Added graph database" diff --git a/docker/run_tests.sh b/docker/run_tests.sh deleted file mode 100755 index 6c1768ac..00000000 --- a/docker/run_tests.sh +++ /dev/null @@ -1,33 +0,0 @@ -#!/bin/bash -set -euo pipefail - -source /usr/src/app/node_modules/app.env.sh - -cd "${REPO_DIR}" - -disp=:99 -screen=0 -export DISPLAY="${disp}.${screen}" - -apt-get install -y nginx - -echo "starting nginx" -nginx -c /etc/nginx/e2e_proxy.conf - -echo "starting xvfb" -Xvfb "${disp}" -ac -listen tcp -screen "${screen}" 1200x800x24 & - -echo "starting fluxbox" -fluxbox -display "${disp}" -screen "${screen}" & - -if [[ -z "$ENABLE_VNC" ]]; then - echo "vnc disabled" -else - echo "starting vnc with password 'test'" - x11vnc -display "${DISPLAY}" -forever -bg -passwd password -fi - -yarn playwright install-deps -yarn playwright install - -yarn playwright test diff --git a/docker/scripts/build-base.sh b/docker/scripts/build-base.sh deleted file mode 100644 index 6ce31d2e..00000000 --- a/docker/scripts/build-base.sh +++ /dev/null @@ -1,16 +0,0 @@ -#!/bin/bash -set -euxo pipefail - -script_dir=$( cd -- "$( dirname -- "${BASH_SOURCE[0]}" )" &> /dev/null && pwd ) - -# This needs to be set because of dealing with M1 macs and github actions. -# Github actions cannot seem to build _some_ arm64 images. This gets around that -# by forcing us to tag with the platform. -DOCKER_PLATFORM=${DOCKER_PLATFORM:-amd64} - -cd "$script_dir/.." - -docker build \ - -t "ghcr.io/hypercerts-org/node-dev-18:1.0-${DOCKER_PLATFORM}" \ - -f base.Dockerfile . -docker push "ghcr.io/hypercerts-org/node-dev-18:1.0-${DOCKER_PLATFORM}" \ No newline at end of file diff --git a/docker/scripts/build-graph-dependencies.sh b/docker/scripts/build-graph-dependencies.sh deleted file mode 100644 index 242c45a0..00000000 --- a/docker/scripts/build-graph-dependencies.sh +++ /dev/null @@ -1,45 +0,0 @@ -#!/bin/bash -set -euxo pipefail - -# Save the script's directory for later -script_dir=$( cd -- "$( dirname -- "${BASH_SOURCE[0]}" )" &> /dev/null && pwd ) - -echo "Creating a temporary directory to checkout the graph" -temp_dir=$(mktemp -d) - -cd "$temp_dir" - -# checkout the graph -git clone https://github.com/graphprotocol/graph-node.git -cd graph-node/ - -clean_up() { - rm -rf "$temp_dir" - echo "Cleaning up temp directory" -} -trap clean_up EXIT - -if [ -d .git ] -then - COMMIT_SHA=$(git rev-parse HEAD) - TAG_NAME=$(git tag --points-at HEAD) - REPO_NAME="Checkout of $(git remote get-url origin) at $(git describe --dirty)" - BRANCH_NAME=$(git rev-parse --abbrev-ref HEAD) -fi - -# This needs to be set because of dealing with M1 macs and github actions. -# Github actions cannot seem to build _some_ arm64 images. This gets around that -# by forcing us to tag with the platform. -DOCKER_PLATFORM=${DOCKER_PLATFORM:-amd64} - -for stage in graph-node-build graph-node graph-node-debug -do - docker build --target $stage \ - --build-arg "COMMIT_SHA=$COMMIT_SHA" \ - --build-arg "REPO_NAME=$REPO_NAME" \ - --build-arg "BRANCH_NAME=$BRANCH_NAME" \ - --build-arg "TAG_NAME=$TAG_NAME" \ - -t ghcr.io/hypercerts-org/$stage:${COMMIT_SHA}-${DOCKER_PLATFORM} \ - --push \ - -f docker/Dockerfile . -done \ No newline at end of file diff --git a/docker/scripts/build-graph.sh b/docker/scripts/build-graph.sh deleted file mode 100644 index 45d9fcfc..00000000 --- a/docker/scripts/build-graph.sh +++ /dev/null @@ -1,41 +0,0 @@ -#!/bin/bash -set -euxo pipefail - -# Save the script's directory for later -script_dir=$( cd -- "$( dirname -- "${BASH_SOURCE[0]}" )" &> /dev/null && pwd ) - -echo "Creating a temporary directory to checkout the graph" -temp_dir=$(mktemp -d) - -cd "$temp_dir" - -# checkout the graph -git clone https://github.com/graphprotocol/graph-node.git -cd graph-node/ - -clean_up() { - rm -rf "$temp_dir" - echo "Cleaning up temp directory" -} -trap clean_up EXIT - -if [ -d .git ] -then - COMMIT_SHA=$(git rev-parse HEAD) - TAG_NAME=$(git tag --points-at HEAD) - REPO_NAME="Checkout of $(git remote get-url origin) at $(git describe --dirty)" - BRANCH_NAME=$(git rev-parse --abbrev-ref HEAD) -fi - -# This needs to be set because of dealing with M1 macs and github actions. -# Github actions cannot seem to build _some_ arm64 images. This gets around that -# by forcing us to tag with the platform. -DOCKER_PLATFORM=${DOCKER_PLATFORM:-amd64} - -cd "${script_dir}/.." -docker build \ - -t "ghcr.io/hypercerts-org/graph-node-dev:${COMMIT_SHA}-${DOCKER_PLATFORM}" \ - --build-arg "DOCKER_PLATFORM=${DOCKER_PLATFORM}" \ - --build-arg "GRAPH_COMMIT_SHA=${COMMIT_SHA}" \ - --push \ - -f graph.Dockerfile . \ No newline at end of file diff --git a/docker/scripts/build-playwright.sh b/docker/scripts/build-playwright.sh deleted file mode 100644 index 192a94a8..00000000 --- a/docker/scripts/build-playwright.sh +++ /dev/null @@ -1,16 +0,0 @@ -#!/bin/bash -set -euxo pipefail - -script_dir=$( cd -- "$( dirname -- "${BASH_SOURCE[0]}" )" &> /dev/null && pwd ) - -# This needs to be set because of dealing with M1 macs and github actions. -# Github actions cannot seem to build _some_ arm64 images. This gets around that -# by forcing us to tag with the platform. -DOCKER_PLATFORM=${DOCKER_PLATFORM:-amd64} - -cd "$script_dir/.." - -docker build \ - -t "ghcr.io/hypercerts-org/playwright:v1.35.0-${DOCKER_PLATFORM}" \ - --push \ - -f playwright.Dockerfile . \ No newline at end of file diff --git a/docker/tx_client.sh b/docker/tx_client.sh deleted file mode 100755 index 35579834..00000000 --- a/docker/tx_client.sh +++ /dev/null @@ -1,8 +0,0 @@ -#!/bin/bash -set -euo pipefail - -source /usr/src/app/node_modules/app.env.sh - -cd "${REPO_DIR}/contracts" - -yarn hardhat --network localhost test-tx-client \ No newline at end of file diff --git a/docs/.eslintrc.yml b/docs/.eslintrc.yml deleted file mode 100644 index c1258f9f..00000000 --- a/docs/.eslintrc.yml +++ /dev/null @@ -1,27 +0,0 @@ -extends: - - "eslint:recommended" - - "plugin:@typescript-eslint/eslint-recommended" - - "plugin:@typescript-eslint/recommended" - - "prettier" -parser: "@typescript-eslint/parser" -parserOptions: - project: "./docs/tsconfig.json" -plugins: - - "@docusaurus" - - "@typescript-eslint" -root: true -ignorePatterns: ["build/"] -rules: - "@typescript-eslint/semi": - - warn - "@typescript-eslint/switch-exhaustiveness-check": - - warn - "@typescript-eslint/no-floating-promises": - - error - - ignoreIIFE: true - ignoreVoid: true - "@typescript-eslint/no-inferrable-types": "off" - "@typescript-eslint/no-unused-vars": - - error - - argsIgnorePattern: "_" - varsIgnorePattern: "_" diff --git a/docs/.gitignore b/docs/.gitignore deleted file mode 100644 index 3651560a..00000000 --- a/docs/.gitignore +++ /dev/null @@ -1,22 +0,0 @@ -# Dependencies -/node_modules - -# Production -/build - -# Generated files -.docusaurus -.cache-loader - -# Misc -.DS_Store -.env.local -.env.development.local -.env.test.local -.env.production.local - -npm-debug.log* -yarn-debug.log* -yarn-error.log* - -.idea \ No newline at end of file diff --git a/docs/README.md b/docs/README.md deleted file mode 100644 index bc59add5..00000000 --- a/docs/README.md +++ /dev/null @@ -1,40 +0,0 @@ -# Website - -You can find the production version of this website at [https://hypercerts.org/docs](https://hypercerts.org/docs) - -This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator. - -NOTE: By default, all edits to `docs/` will be hidden behind the `Next` version in the navbar until the version is released. To cut a release, see the section on [versioning](#versioning). - -### Local Development - -``` -$ yarn -$ yarn start -``` - -This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server. - -### Build - -``` -$ yarn build -``` - -This command generates static content into the `build` directory and can be served using any static contents hosting service. - -### Deployment - -Using SSH: - -``` -$ USE_SSH=true yarn deploy -``` - -Not using SSH: - -``` -$ GIT_USER= yarn deploy -``` - -If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch. diff --git a/docs/babel.config.ts b/docs/babel.config.ts deleted file mode 100644 index 4e1c4976..00000000 --- a/docs/babel.config.ts +++ /dev/null @@ -1,3 +0,0 @@ -export const config = { - presets: "@docusaurus/core/lib/babel/preset", -}; diff --git a/docs/docs/about.md b/docs/docs/about.md deleted file mode 100644 index b56bfa4f..00000000 --- a/docs/docs/about.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -title: The Hypercerts Foundation -id: about ---- - -# The Hypercerts Foundation - -### Mission -The mission of the Hypercerts Foundation is to advance the development and adoption of open-source protocols for funding and rewarding positive impact. - -### Organization - -The Hypercerts Foundation is a fully independent organisation working closely with stakeholders in the open source, scientific research, and cryptography communities to develop and promote additional protocols that are decentralized, secure, and transparent. The Foundation will also provide support and resources to help drive the wider adoption of these protocols. - -### History - -Research on hypercerts was first presented to the public by David A. Dalrymple at the conference series Funding the Commons in March 2022. However, the concept of “impact certificates” has been a recurring theme at conferences and in online discussion forums since at least 2014. In late 2022, a small team of research scientists, developers, and practitioners began implementing hypercerts as a set of Ethereum-based smart contracts that could be used to assert and fund impact claims. The Hypercerts Foundation will now serve as the long-term home for this work. - -The new foundation is supported in part by Protocol Labs and is part of the broader Protocol Labs Network of hundreds of companies and organizations. The Foundation will complement Protocol Labs Network’s mission of enabling a more secure, open, and accessible internet. The Hypercerts Foundation, however, is fully independent and will focus on protocol development and cultivating a community of developers and impact entrepreneurs well beyond the Protocol Labs Network. - -### Further links -Read the full [announcement of the Hypercerts Foundation](https://hypercerts.notion.site/Introducing-the-Hypercerts-Foundation-d956203fe0fc4792980da138015e770a). diff --git a/docs/docs/announcements/2024_01_16_An_Impactful_Year.md b/docs/docs/announcements/2024_01_16_An_Impactful_Year.md deleted file mode 100644 index 3ec4a3d1..00000000 --- a/docs/docs/announcements/2024_01_16_An_Impactful_Year.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: An Impactful Year -id: an-impactful-year.md ---- - -# Announcements - -### Hypercerts are a new token standard for tracking and rewarding positive impact. - -Gm gm. We’re wishing you an impactful 2024. We’re excited for the things ahead! - -2023 has been a year of maturing the foundations laid by the release of the protocol. Together with Grants Stack, Funding the Commons, da0, Zuzalu and many other partners, we’ve successfully run a set of hypercerts pilots. We are grateful for our partners and the enthusiasm of their communities about hypercerts. At every event, we feel the positive energy about hypercerts and about the value mechanism they can unlock. - -At the end of the year, we started developing the hypercert marketplace, which will be released on Sepolia later this week. The marketplace is a fork of LooksRare with modifications to add native support for hypercerts. Thanks to their high quality open source code we were able to use both their exchange contracts as well as the SDK. Special credits go to [Trust Security](https://x.com/trust__90) for not only thoroughly reviewing the changes we’ve made to the stack, but also for going beyond their scope to help us improve our protocol. - -To help developers get onboarded with our tec,h we’ve released a [Next.JS starter app](https://github.com/hypercerts-org/hypercert-nextjs-chakra-starter), a repo with minimal [demo apps](https://github.com/hypercerts-org/demo-apps) for JS, TS on both server and client side, and of course, the [hypercerts SDK v1](https://www.npmjs.com/package/@hypercerts-org/sdk). The SDK provides methods and utilities for minting and claiming hypercerts, validating datasets, and uploading to and fetching from IPFS. - -All of this work is supported by GG19, the first Octant epoch, Optimism’s retroPGF and of course Protocol Labs. A big thank you to all supporters. - -In the next months, we’ll work with close collaborators to build out the evaluation functionalities and provide support to projects that want to integrate hypercerts into their funding systems (similar to how we are integrating hypercerts with Gitcoin) or want to build new applications using hypercerts. If you want to build on top of the hypercerts protocol, please get in contact with us. - -Excited and grateful, - -The hypercerts team diff --git a/docs/docs/developer/allowlists.md b/docs/docs/developer/allowlists.md deleted file mode 100644 index 61200236..00000000 --- a/docs/docs/developer/allowlists.md +++ /dev/null @@ -1,101 +0,0 @@ -# Allowlists - -Allowlists are an efficient way to enable distribution of hypercert fractions amongst a group. -First, the creator will create the hypercert with the metadata and an immutable allowlist. -With the `claimId`, every account specified in the allowlist can later mint their fraction token from that allowlist. - -## Create an allowlist - -First specify an allowlist, mapping addresses to the number of units they should receive. - -```js -import { - TransferRestrictions, - formatHypercertData, - Allowlist, -} from "@hypercerts-org/sdk"; - -const allowlist: Allowlist = [ - { address: "0x123....asfcnaes", units: 100n }, - { address: "0xabc....w2dwqwef", units: 100n }, -]; -``` - -Then, call `createAllowlist` with the metadata and allowlist. - -```js -const { metadata } = formatHypercertData(...); -const totalUnits = 10000n; -const transferRestrictions = TransferRestrictions.FromCreatorOnly - -const txHash = await hypercerts.createAllowlist({ - allowList, - metaData, - totalUnits, - transferRestrictions: TransferRestrictions.FromCreatorOnly, -}); -``` - -> **note** We store the allowlist and the Merkle tree in the metadata of the Hypercert. To understand the Merkle tree generation and data structures, check out the [OpenZeppelin merkle tree library](https://github.com/OpenZeppelin/merkle-tree) - -It first checks if the client is writable and if the operator is a signer. If the operator is not a signer, it throws an `InvalidOrMissingError`. - -Next, it validates the allowlist and metadata by calling the `validateAllowlist` and `validateMetaData` functions respectively. If either the allowlist or metadata is invalid, it throws a `MalformedDataError`. - -Once the allowlist and metadata are validated, the method creates a Merkle tree from the allowlist and stores it on IPFS. It then stores the metadata on IPFS as well. - -Finally, the method invokes the `createAllowlist` function on the contract with the signer's `address`, the total number of `units`, the Merkle tree `root`, the metadata `CID`, and the `transfer restrictions`. If the method is called with `overrides`, it passes them to the createAllowlist function. - -## Claiming a fraction token - -Users can claim their fraction tokens for many hypercerts at once using `mintClaimFractionFromAllowlist`. To determine the input the following information is required: - -| Variable | Type | Source | -| -------- | ------ | ------------- | ----------- | -| claimId | bigint | Hypercert ID | -| units | bigint | Allowlist | -| proof | `(Hex | ByteArray)[]` | Merkle tree | - -We store the allowlist and the Merkle tree in the metadata of the Hypercert. To understand the Merkle tree data structures, check out the [OpenZeppelin merkle tree library](https://github.com/OpenZeppelin/merkle-tree). You can get the `proof` and `units` by traversing the merkle tree. - -Then, call `mintClaimFractionFromAllowlist` with the required data. The contracts will also verify the proofs. However, when providing the `root` in the function input, the proofs will be verified before a transaction is submitted. - -```js -import { StandardMerkleTree } from "@openzeppelin/merkle-tree"; - -const claimId = "0x822f17a9a5eecfd...85254363386255337"; -const address = "0xc0ffee254729296a45a3885639AC7E10F9d54979"; - -const { indexer, storage } = hypercertsClient; -const claimById = await indexer.claimById(claimId); -const { uri, tokenID: _id } = claimById.claim; -const metadata = await storage.getMetadata(uri || ""); -const treeResponse = await storage.getData(metadata.allowList); -const tree = StandardMerkleTree.load(JSON.parse(treeResponse)); - -let args; -// Find the proof in the allowlist -for (const [leaf, value] of tree.entries()) { - if (value[0] === address) { - args = { - proofs: tree.getProof(leaf), - units: Number(value[1]), - claimId: _id, - }; - break; - } -} - -// Mint fraction token -const tx = await hypercerts.mintClaimFractionFromAllowlist({ - ...args, -}); -``` - -Let's see what happens under the hood: - -First, the method checks that the client is not `read only` and that the operator is a signer. If not, it throws an `InvalidOrMissingError`. - -Next, the method verifies the Merkle `proof` using the OpenZeppelin Merkle tree library. If a `root` is provided, the method uses it to verify the proof. If the proof is invalid, it throws an error. - -Finally, the method calls the `mintClaimFromAllowlist` function on the contract with the signer `address`, Merkle `proof`, `claim ID`, and number of `units` as parameters. If overrides are provided, the method uses them to send the transaction. Otherwise, it sends the transaction without overrides. diff --git a/docs/docs/developer/api/contracts/marketplace/BatchOrderTypehashRegistry.md b/docs/docs/developer/api/contracts/marketplace/BatchOrderTypehashRegistry.md deleted file mode 100644 index 4cb96bfc..00000000 --- a/docs/docs/developer/api/contracts/marketplace/BatchOrderTypehashRegistry.md +++ /dev/null @@ -1,46 +0,0 @@ -# BatchOrderTypehashRegistry - -_LooksRare protocol team (👀,💎)_ - -> BatchOrderTypehashRegistry - -The contract generates the batch order hash that is used to compute the digest for signature verification. - -## Methods - -### hashBatchOrder - -```solidity -function hashBatchOrder(bytes32 root, uint256 proofLength) external pure returns (bytes32 batchOrderHash) -``` - -This function returns the hash of the concatenation of batch order type hash and merkle root. - -#### Parameters - -| Name | Type | Description | -| ----------- | ------- | ------------------- | -| root | bytes32 | Merkle root | -| proofLength | uint256 | Merkle proof length | - -#### Returns - -| Name | Type | Description | -| -------------- | ------- | -------------------- | -| batchOrderHash | bytes32 | The batch order hash | - -## Errors - -### MerkleProofTooLarge - -```solidity -error MerkleProofTooLarge(uint256 length) -``` - -It is returned if the length of the merkle proof provided is greater than tolerated. - -#### Parameters - -| Name | Type | Description | -| ------ | ------- | ------------ | -| length | uint256 | Proof length | diff --git a/docs/docs/developer/api/contracts/marketplace/CreatorFeeManagerWithRebates.md b/docs/docs/developer/api/contracts/marketplace/CreatorFeeManagerWithRebates.md deleted file mode 100644 index a32aef65..00000000 --- a/docs/docs/developer/api/contracts/marketplace/CreatorFeeManagerWithRebates.md +++ /dev/null @@ -1,76 +0,0 @@ -# CreatorFeeManagerWithRebates - -_LooksRare protocol team (👀,💎)_ - -> CreatorFeeManagerWithRebates - -This contract returns the creator fee address and the creator rebate amount. - -## Methods - -### STANDARD_ROYALTY_FEE_BP - -```solidity -function STANDARD_ROYALTY_FEE_BP() external view returns (uint256) -``` - -Standard royalty fee (in basis point). - -#### Returns - -| Name | Type | Description | -| ---- | ------- | ----------- | -| \_0 | uint256 | undefined | - -### royaltyFeeRegistry - -```solidity -function royaltyFeeRegistry() external view returns (contract IRoyaltyFeeRegistry) -``` - -Royalty fee registry interface. - -#### Returns - -| Name | Type | Description | -| ---- | ---------------------------- | ----------- | -| \_0 | contract IRoyaltyFeeRegistry | undefined | - -### viewCreatorFeeInfo - -```solidity -function viewCreatorFeeInfo(address collection, uint256 price, uint256[] itemIds) external view returns (address creator, uint256 creatorFeeAmount) -``` - -This function returns the creator address and calculates the creator fee amount. - -#### Parameters - -| Name | Type | Description | -| ---------- | --------- | ------------------ | -| collection | address | Collection address | -| price | uint256 | Transaction price | -| itemIds | uint256[] | Array of item ids | - -#### Returns - -| Name | Type | Description | -| ---------------- | ------- | ------------------ | -| creator | address | Creator address | -| creatorFeeAmount | uint256 | Creator fee amount | - -## Errors - -### BundleEIP2981NotAllowed - -```solidity -error BundleEIP2981NotAllowed(address collection) -``` - -It is returned if the bundle contains multiple itemIds with different creator fee structure. - -#### Parameters - -| Name | Type | Description | -| ---------- | ------- | ----------- | -| collection | address | undefined | diff --git a/docs/docs/developer/api/contracts/marketplace/CreatorFeeManagerWithRoyalties.md b/docs/docs/developer/api/contracts/marketplace/CreatorFeeManagerWithRoyalties.md deleted file mode 100644 index 41cab900..00000000 --- a/docs/docs/developer/api/contracts/marketplace/CreatorFeeManagerWithRoyalties.md +++ /dev/null @@ -1,64 +0,0 @@ -# CreatorFeeManagerWithRoyalties - -_LooksRare protocol team (👀,💎)_ - -> CreatorFeeManagerWithRoyalties - -This contract returns the creator fee address and the creator fee amount. - -## Methods - -### royaltyFeeRegistry - -```solidity -function royaltyFeeRegistry() external view returns (contract IRoyaltyFeeRegistry) -``` - -Royalty fee registry interface. - -#### Returns - -| Name | Type | Description | -| ---- | ---------------------------- | ----------- | -| \_0 | contract IRoyaltyFeeRegistry | undefined | - -### viewCreatorFeeInfo - -```solidity -function viewCreatorFeeInfo(address collection, uint256 price, uint256[] itemIds) external view returns (address creator, uint256 creatorFeeAmount) -``` - -This function returns the creator address and calculates the creator fee amount. - -_There are two on-chain sources for the royalty fee to distribute. 1. RoyaltyFeeRegistry: It is an on-chain registry where creator fee is defined for all items of a collection. 2. ERC2981: The NFT Royalty Standard where royalty fee is defined at a itemId level in a collection. The on-chain logic looks up the registry first. If it does not find anything, it checks if a collection is ERC2981. If so, it fetches the proper royalty information for the itemId. For a bundle that contains multiple itemIds (for a collection using ERC2981), if the royalty fee/recipient differ among the itemIds part of the bundle, the trade reverts. This contract DOES NOT enforce any restriction for extremely high creator fee, nor verifies the creator fee fetched is inferior to the total price. If any contract relies on it to build an on-chain royalty logic, it should implement protection against: (1) high royalties (2) potential unexpected royalty changes that can occur after the creation of the order._ - -#### Parameters - -| Name | Type | Description | -| ---------- | --------- | ------------------ | -| collection | address | Collection address | -| price | uint256 | Transaction price | -| itemIds | uint256[] | Array of item ids | - -#### Returns - -| Name | Type | Description | -| ---------------- | ------- | ------------------ | -| creator | address | Creator address | -| creatorFeeAmount | uint256 | Creator fee amount | - -## Errors - -### BundleEIP2981NotAllowed - -```solidity -error BundleEIP2981NotAllowed(address collection) -``` - -It is returned if the bundle contains multiple itemIds with different creator fee structure. - -#### Parameters - -| Name | Type | Description | -| ---------- | ------- | ----------- | -| collection | address | undefined | diff --git a/docs/docs/developer/api/contracts/marketplace/CurrencyManager.md b/docs/docs/developer/api/contracts/marketplace/CurrencyManager.md deleted file mode 100644 index 9ff1c0fc..00000000 --- a/docs/docs/developer/api/contracts/marketplace/CurrencyManager.md +++ /dev/null @@ -1,250 +0,0 @@ -# CurrencyManager - -_LooksRare protocol team (👀,💎)_ - -> CurrencyManager - -This contract manages the list of valid fungible currencies. - -## Methods - -### cancelOwnershipTransfer - -```solidity -function cancelOwnershipTransfer() external nonpayable -``` - -This function is used to cancel the ownership transfer. - -_This function can be used for both cancelling a transfer to a new owner and cancelling the renouncement of the ownership._ - -### confirmOwnershipRenouncement - -```solidity -function confirmOwnershipRenouncement() external nonpayable -``` - -This function is used to confirm the ownership renouncement. - -### confirmOwnershipTransfer - -```solidity -function confirmOwnershipTransfer() external nonpayable -``` - -This function is used to confirm the ownership transfer. - -_This function can only be called by the current potential owner._ - -### initiateOwnershipRenouncement - -```solidity -function initiateOwnershipRenouncement() external nonpayable -``` - -This function is used to initiate the ownership renouncement. - -### initiateOwnershipTransfer - -```solidity -function initiateOwnershipTransfer(address newPotentialOwner) external nonpayable -``` - -This function is used to initiate the transfer of ownership to a new owner. - -#### Parameters - -| Name | Type | Description | -| ----------------- | ------- | --------------------------- | -| newPotentialOwner | address | New potential owner address | - -### isCurrencyAllowed - -```solidity -function isCurrencyAllowed(address) external view returns (bool) -``` - -It checks whether the currency is allowed for transacting. - -#### Parameters - -| Name | Type | Description | -| ---- | ------- | ----------- | -| \_0 | address | undefined | - -#### Returns - -| Name | Type | Description | -| ---- | ---- | ----------- | -| \_0 | bool | undefined | - -### owner - -```solidity -function owner() external view returns (address) -``` - -Address of the current owner. - -#### Returns - -| Name | Type | Description | -| ---- | ------- | ----------- | -| \_0 | address | undefined | - -### ownershipStatus - -```solidity -function ownershipStatus() external view returns (enum IOwnableTwoSteps.Status) -``` - -Ownership status. - -#### Returns - -| Name | Type | Description | -| ---- | ---------------------------- | ----------- | -| \_0 | enum IOwnableTwoSteps.Status | undefined | - -### potentialOwner - -```solidity -function potentialOwner() external view returns (address) -``` - -Address of the potential owner. - -#### Returns - -| Name | Type | Description | -| ---- | ------- | ----------- | -| \_0 | address | undefined | - -### updateCurrencyStatus - -```solidity -function updateCurrencyStatus(address currency, bool isAllowed) external nonpayable -``` - -This function allows the owner to update the status of a currency. - -_Only callable by owner._ - -#### Parameters - -| Name | Type | Description | -| --------- | ------- | -------------------------------------------------- | -| currency | address | Currency address (address(0) for ETH) | -| isAllowed | bool | Whether the currency should be allowed for trading | - -## Events - -### CancelOwnershipTransfer - -```solidity -event CancelOwnershipTransfer() -``` - -This is emitted if the ownership transfer is cancelled. - -### CurrencyStatusUpdated - -```solidity -event CurrencyStatusUpdated(address currency, bool isAllowed) -``` - -It is emitted if the currency status in the allowlist is updated. - -#### Parameters - -| Name | Type | Description | -| --------- | ------- | ----------- | -| currency | address | undefined | -| isAllowed | bool | undefined | - -### InitiateOwnershipRenouncement - -```solidity -event InitiateOwnershipRenouncement() -``` - -This is emitted if the ownership renouncement is initiated. - -### InitiateOwnershipTransfer - -```solidity -event InitiateOwnershipTransfer(address previousOwner, address potentialOwner) -``` - -This is emitted if the ownership transfer is initiated. - -#### Parameters - -| Name | Type | Description | -| -------------- | ------- | ----------- | -| previousOwner | address | undefined | -| potentialOwner | address | undefined | - -### NewOwner - -```solidity -event NewOwner(address newOwner) -``` - -This is emitted when there is a new owner. - -#### Parameters - -| Name | Type | Description | -| -------- | ------- | ----------- | -| newOwner | address | undefined | - -## Errors - -### NoOngoingTransferInProgress - -```solidity -error NoOngoingTransferInProgress() -``` - -This is returned when there is no transfer of ownership in progress. - -### NotOwner - -```solidity -error NotOwner() -``` - -This is returned when the caller is not the owner. - -### RenouncementNotInProgress - -```solidity -error RenouncementNotInProgress() -``` - -This is returned when there is no renouncement in progress but the owner tries to validate the ownership renouncement. - -### TransferAlreadyInProgress - -```solidity -error TransferAlreadyInProgress() -``` - -This is returned when the transfer is already in progress but the owner tries initiate a new ownership transfer. - -### TransferNotInProgress - -```solidity -error TransferNotInProgress() -``` - -This is returned when there is no ownership transfer in progress but the ownership change tries to be approved. - -### WrongPotentialOwner - -```solidity -error WrongPotentialOwner() -``` - -This is returned when the ownership transfer is attempted to be validated by the a caller that is not the potential owner. diff --git a/docs/docs/developer/api/contracts/marketplace/ExecutionManager.md b/docs/docs/developer/api/contracts/marketplace/ExecutionManager.md deleted file mode 100644 index 83eefc37..00000000 --- a/docs/docs/developer/api/contracts/marketplace/ExecutionManager.md +++ /dev/null @@ -1,751 +0,0 @@ -# ExecutionManager - -_LooksRare protocol team (👀,💎); bitbeckers;_ - -> ExecutionManager - -This contract handles the execution and resolution of transactions. A transaction is executed on-chain when an off-chain maker order is matched by on-chain taker order of a different kind. For instance, a taker ask is executed against a maker bid (or a taker bid against a maker ask). - -## Methods - -### MAGIC_VALUE_ORDER_NONCE_EXECUTED - -```solidity -function MAGIC_VALUE_ORDER_NONCE_EXECUTED() external view returns (bytes32) -``` - -Magic value nonce returned if executed (or cancelled). - -#### Returns - -| Name | Type | Description | -| ---- | ------- | ----------- | -| \_0 | bytes32 | undefined | - -### addStrategy - -```solidity -function addStrategy(uint16 standardProtocolFeeBp, uint16 minTotalFeeBp, uint16 maxProtocolFeeBp, bytes4 selector, bool isMakerBid, address implementation) external nonpayable -``` - -This function allows the owner to add a new execution strategy to the protocol. - -_Strategies have an id that is incremental. Only callable by owner._ - -#### Parameters - -| Name | Type | Description | -| --------------------- | ------- | ---------------------------------------------- | -| standardProtocolFeeBp | uint16 | Standard protocol fee (in basis point) | -| minTotalFeeBp | uint16 | Minimum total fee (in basis point) | -| maxProtocolFeeBp | uint16 | Maximum protocol fee (in basis point) | -| selector | bytes4 | Function selector for the strategy | -| isMakerBid | bool | Whether the function selector is for maker bid | -| implementation | address | Implementation address | - -### cancelOrderNonces - -```solidity -function cancelOrderNonces(uint256[] orderNonces) external nonpayable -``` - -This function allows a user to cancel an array of order nonces. - -_It does not check the status of the nonces to save gas and to prevent revertion if one of the orders is filled in the same block._ - -#### Parameters - -| Name | Type | Description | -| ----------- | --------- | --------------------- | -| orderNonces | uint256[] | Array of order nonces | - -### cancelOwnershipTransfer - -```solidity -function cancelOwnershipTransfer() external nonpayable -``` - -This function is used to cancel the ownership transfer. - -_This function can be used for both cancelling a transfer to a new owner and cancelling the renouncement of the ownership._ - -### cancelSubsetNonces - -```solidity -function cancelSubsetNonces(uint256[] subsetNonces) external nonpayable -``` - -This function allows a user to cancel an array of subset nonces. - -_It does not check the status of the nonces to save gas._ - -#### Parameters - -| Name | Type | Description | -| ------------ | --------- | ---------------------- | -| subsetNonces | uint256[] | Array of subset nonces | - -### confirmOwnershipRenouncement - -```solidity -function confirmOwnershipRenouncement() external nonpayable -``` - -This function is used to confirm the ownership renouncement. - -### confirmOwnershipTransfer - -```solidity -function confirmOwnershipTransfer() external nonpayable -``` - -This function is used to confirm the ownership transfer. - -_This function can only be called by the current potential owner._ - -### creatorFeeManager - -```solidity -function creatorFeeManager() external view returns (contract ICreatorFeeManager) -``` - -Creator fee manager. - -#### Returns - -| Name | Type | Description | -| ---- | --------------------------- | ----------- | -| \_0 | contract ICreatorFeeManager | undefined | - -### incrementBidAskNonces - -```solidity -function incrementBidAskNonces(bool bid, bool ask) external nonpayable -``` - -This function increments a user's bid/ask nonces. - -_The logic for computing the quasi-random number is inspired by Seaport v1.2. The pseudo-randomness allows non-deterministic computation of the next ask/bid nonce. A deterministic increment would make the cancel-all process non-effective in certain cases (orders signed with a greater ask/bid nonce). The same quasi-random number is used for incrementing both the bid and ask nonces if both values are incremented in the same transaction. If this function is used twice in the same block, it will return the same quasiRandomNumber but this will not impact the overall business logic._ - -#### Parameters - -| Name | Type | Description | -| ---- | ---- | --------------------------------------- | -| bid | bool | Whether to increment the user bid nonce | -| ask | bool | Whether to increment the user ask nonce | - -### initiateOwnershipRenouncement - -```solidity -function initiateOwnershipRenouncement() external nonpayable -``` - -This function is used to initiate the ownership renouncement. - -### initiateOwnershipTransfer - -```solidity -function initiateOwnershipTransfer(address newPotentialOwner) external nonpayable -``` - -This function is used to initiate the transfer of ownership to a new owner. - -#### Parameters - -| Name | Type | Description | -| ----------------- | ------- | --------------------------- | -| newPotentialOwner | address | New potential owner address | - -### isCurrencyAllowed - -```solidity -function isCurrencyAllowed(address) external view returns (bool) -``` - -It checks whether the currency is allowed for transacting. - -#### Parameters - -| Name | Type | Description | -| ---- | ------- | ----------- | -| \_0 | address | undefined | - -#### Returns - -| Name | Type | Description | -| ---- | ---- | ----------- | -| \_0 | bool | undefined | - -### maxCreatorFeeBp - -```solidity -function maxCreatorFeeBp() external view returns (uint16) -``` - -Maximum creator fee (in basis point). - -#### Returns - -| Name | Type | Description | -| ---- | ------ | ----------- | -| \_0 | uint16 | undefined | - -### owner - -```solidity -function owner() external view returns (address) -``` - -Address of the current owner. - -#### Returns - -| Name | Type | Description | -| ---- | ------- | ----------- | -| \_0 | address | undefined | - -### ownershipStatus - -```solidity -function ownershipStatus() external view returns (enum IOwnableTwoSteps.Status) -``` - -Ownership status. - -#### Returns - -| Name | Type | Description | -| ---- | ---------------------------- | ----------- | -| \_0 | enum IOwnableTwoSteps.Status | undefined | - -### potentialOwner - -```solidity -function potentialOwner() external view returns (address) -``` - -Address of the potential owner. - -#### Returns - -| Name | Type | Description | -| ---- | ------- | ----------- | -| \_0 | address | undefined | - -### protocolFeeRecipient - -```solidity -function protocolFeeRecipient() external view returns (address) -``` - -Protocol fee recipient. - -#### Returns - -| Name | Type | Description | -| ---- | ------- | ----------- | -| \_0 | address | undefined | - -### strategyInfo - -```solidity -function strategyInfo(uint256) external view returns (bool isActive, uint16 standardProtocolFeeBp, uint16 minTotalFeeBp, uint16 maxProtocolFeeBp, bytes4 selector, bool isMakerBid, address implementation) -``` - -This returns the strategy information for a strategy id. - -#### Parameters - -| Name | Type | Description | -| ---- | ------- | ----------- | -| \_0 | uint256 | undefined | - -#### Returns - -| Name | Type | Description | -| --------------------- | ------- | ----------- | -| isActive | bool | undefined | -| standardProtocolFeeBp | uint16 | undefined | -| minTotalFeeBp | uint16 | undefined | -| maxProtocolFeeBp | uint16 | undefined | -| selector | bytes4 | undefined | -| isMakerBid | bool | undefined | -| implementation | address | undefined | - -### updateCreatorFeeManager - -```solidity -function updateCreatorFeeManager(address newCreatorFeeManager) external nonpayable -``` - -This function allows the owner to update the creator fee manager address. - -_Only callable by owner._ - -#### Parameters - -| Name | Type | Description | -| -------------------- | ------- | ---------------------------------- | -| newCreatorFeeManager | address | Address of the creator fee manager | - -### updateCurrencyStatus - -```solidity -function updateCurrencyStatus(address currency, bool isAllowed) external nonpayable -``` - -This function allows the owner to update the status of a currency. - -_Only callable by owner._ - -#### Parameters - -| Name | Type | Description | -| --------- | ------- | -------------------------------------------------- | -| currency | address | Currency address (address(0) for ETH) | -| isAllowed | bool | Whether the currency should be allowed for trading | - -### updateMaxCreatorFeeBp - -```solidity -function updateMaxCreatorFeeBp(uint16 newMaxCreatorFeeBp) external nonpayable -``` - -This function allows the owner to update the maximum creator fee (in basis point). - -_The maximum value that can be set is 25%. Only callable by owner._ - -#### Parameters - -| Name | Type | Description | -| ------------------ | ------ | ---------------------------------------- | -| newMaxCreatorFeeBp | uint16 | New maximum creator fee (in basis point) | - -### updateProtocolFeeRecipient - -```solidity -function updateProtocolFeeRecipient(address newProtocolFeeRecipient) external nonpayable -``` - -This function allows the owner to update the protocol fee recipient. - -_Only callable by owner._ - -#### Parameters - -| Name | Type | Description | -| ----------------------- | ------- | ---------------------------------- | -| newProtocolFeeRecipient | address | New protocol fee recipient address | - -### updateStrategy - -```solidity -function updateStrategy(uint256 strategyId, bool isActive, uint16 newStandardProtocolFee, uint16 newMinTotalFee) external nonpayable -``` - -This function allows the owner to update parameters for an existing execution strategy. - -_Only callable by owner._ - -#### Parameters - -| Name | Type | Description | -| ---------------------- | ------- | ------------------------------------------ | -| strategyId | uint256 | Strategy id | -| isActive | bool | Whether the strategy must be active | -| newStandardProtocolFee | uint16 | New standard protocol fee (in basis point) | -| newMinTotalFee | uint16 | New minimum total fee (in basis point) | - -### userBidAskNonces - -```solidity -function userBidAskNonces(address) external view returns (uint256 bidNonce, uint256 askNonce) -``` - -This tracks the bid and ask nonces for a user address. - -#### Parameters - -| Name | Type | Description | -| ---- | ------- | ----------- | -| \_0 | address | undefined | - -#### Returns - -| Name | Type | Description | -| -------- | ------- | ----------- | -| bidNonce | uint256 | undefined | -| askNonce | uint256 | undefined | - -### userOrderNonce - -```solidity -function userOrderNonce(address, uint256) external view returns (bytes32) -``` - -This checks whether the order nonce for a user was executed or cancelled. - -#### Parameters - -| Name | Type | Description | -| ---- | ------- | ----------- | -| \_0 | address | undefined | -| \_1 | uint256 | undefined | - -#### Returns - -| Name | Type | Description | -| ---- | ------- | ----------- | -| \_0 | bytes32 | undefined | - -### userSubsetNonce - -```solidity -function userSubsetNonce(address, uint256) external view returns (bool) -``` - -This checks whether the subset nonce for a user was cancelled. - -#### Parameters - -| Name | Type | Description | -| ---- | ------- | ----------- | -| \_0 | address | undefined | -| \_1 | uint256 | undefined | - -#### Returns - -| Name | Type | Description | -| ---- | ---- | ----------- | -| \_0 | bool | undefined | - -## Events - -### CancelOwnershipTransfer - -```solidity -event CancelOwnershipTransfer() -``` - -This is emitted if the ownership transfer is cancelled. - -### CurrencyStatusUpdated - -```solidity -event CurrencyStatusUpdated(address currency, bool isAllowed) -``` - -It is emitted if the currency status in the allowlist is updated. - -#### Parameters - -| Name | Type | Description | -| --------- | ------- | ----------- | -| currency | address | undefined | -| isAllowed | bool | undefined | - -### InitiateOwnershipRenouncement - -```solidity -event InitiateOwnershipRenouncement() -``` - -This is emitted if the ownership renouncement is initiated. - -### InitiateOwnershipTransfer - -```solidity -event InitiateOwnershipTransfer(address previousOwner, address potentialOwner) -``` - -This is emitted if the ownership transfer is initiated. - -#### Parameters - -| Name | Type | Description | -| -------------- | ------- | ----------- | -| previousOwner | address | undefined | -| potentialOwner | address | undefined | - -### NewBidAskNonces - -```solidity -event NewBidAskNonces(address user, uint256 bidNonce, uint256 askNonce) -``` - -It is emitted when there is an update of the global bid/ask nonces for a user. - -#### Parameters - -| Name | Type | Description | -| -------- | ------- | ----------- | -| user | address | undefined | -| bidNonce | uint256 | undefined | -| askNonce | uint256 | undefined | - -### NewCreatorFeeManager - -```solidity -event NewCreatorFeeManager(address creatorFeeManager) -``` - -It is issued when there is a new creator fee manager. - -#### Parameters - -| Name | Type | Description | -| ----------------- | ------- | ----------- | -| creatorFeeManager | address | undefined | - -### NewMaxCreatorFeeBp - -```solidity -event NewMaxCreatorFeeBp(uint256 maxCreatorFeeBp) -``` - -It is issued when there is a new maximum creator fee (in basis point). - -#### Parameters - -| Name | Type | Description | -| --------------- | ------- | ----------- | -| maxCreatorFeeBp | uint256 | undefined | - -### NewOwner - -```solidity -event NewOwner(address newOwner) -``` - -This is emitted when there is a new owner. - -#### Parameters - -| Name | Type | Description | -| -------- | ------- | ----------- | -| newOwner | address | undefined | - -### NewProtocolFeeRecipient - -```solidity -event NewProtocolFeeRecipient(address protocolFeeRecipient) -``` - -It is issued when there is a new protocol fee recipient address. - -#### Parameters - -| Name | Type | Description | -| -------------------- | ------- | ----------- | -| protocolFeeRecipient | address | undefined | - -### NewStrategy - -```solidity -event NewStrategy(uint256 strategyId, uint16 standardProtocolFeeBp, uint16 minTotalFeeBp, uint16 maxProtocolFeeBp, bytes4 selector, bool isMakerBid, address implementation) -``` - -It is emitted when a new strategy is added. - -#### Parameters - -| Name | Type | Description | -| --------------------- | ------- | ----------- | -| strategyId | uint256 | undefined | -| standardProtocolFeeBp | uint16 | undefined | -| minTotalFeeBp | uint16 | undefined | -| maxProtocolFeeBp | uint16 | undefined | -| selector | bytes4 | undefined | -| isMakerBid | bool | undefined | -| implementation | address | undefined | - -### OrderNoncesCancelled - -```solidity -event OrderNoncesCancelled(address user, uint256[] orderNonces) -``` - -It is emitted when order nonces are cancelled for a user. - -#### Parameters - -| Name | Type | Description | -| ----------- | --------- | ----------- | -| user | address | undefined | -| orderNonces | uint256[] | undefined | - -### StrategyUpdated - -```solidity -event StrategyUpdated(uint256 strategyId, bool isActive, uint16 standardProtocolFeeBp, uint16 minTotalFeeBp) -``` - -It is emitted when an existing strategy is updated. - -#### Parameters - -| Name | Type | Description | -| --------------------- | ------- | ----------- | -| strategyId | uint256 | undefined | -| isActive | bool | undefined | -| standardProtocolFeeBp | uint16 | undefined | -| minTotalFeeBp | uint16 | undefined | - -### SubsetNoncesCancelled - -```solidity -event SubsetNoncesCancelled(address user, uint256[] subsetNonces) -``` - -It is emitted when subset nonces are cancelled for a user. - -#### Parameters - -| Name | Type | Description | -| ------------ | --------- | ----------- | -| user | address | undefined | -| subsetNonces | uint256[] | undefined | - -## Errors - -### CreatorFeeBpTooHigh - -```solidity -error CreatorFeeBpTooHigh() -``` - -It is returned if the creator fee (in basis point) is too high. - -### LengthsInvalid - -```solidity -error LengthsInvalid() -``` - -It is returned if there is either a mismatch or an error in the length of the array(s). - -### NewProtocolFeeRecipientCannotBeNullAddress - -```solidity -error NewProtocolFeeRecipientCannotBeNullAddress() -``` - -It is returned if the new protocol fee recipient is set to address(0). - -### NoOngoingTransferInProgress - -```solidity -error NoOngoingTransferInProgress() -``` - -This is returned when there is no transfer of ownership in progress. - -### NoSelectorForStrategy - -```solidity -error NoSelectorForStrategy() -``` - -It is returned if there is no selector for maker ask/bid for a given strategyId, depending on the quote type. - -### NotOwner - -```solidity -error NotOwner() -``` - -This is returned when the caller is not the owner. - -### NotV2Strategy - -```solidity -error NotV2Strategy() -``` - -If the strategy has not set properly its implementation contract. - -_It can only be returned for owner operations._ - -### OutsideOfTimeRange - -```solidity -error OutsideOfTimeRange() -``` - -It is returned if the current block timestamp is not between start and end times in the maker order. - -### RenouncementNotInProgress - -```solidity -error RenouncementNotInProgress() -``` - -This is returned when there is no renouncement in progress but the owner tries to validate the ownership renouncement. - -### StrategyHasNoSelector - -```solidity -error StrategyHasNoSelector() -``` - -It is returned if the strategy has no selector. - -_It can only be returned for owner operations._ - -### StrategyNotAvailable - -```solidity -error StrategyNotAvailable(uint256 strategyId) -``` - -It is returned if the strategy id has no implementation. - -_It is returned if there is no implementation address and the strategyId is strictly greater than 0._ - -#### Parameters - -| Name | Type | Description | -| ---------- | ------- | ----------- | -| strategyId | uint256 | undefined | - -### StrategyNotUsed - -```solidity -error StrategyNotUsed() -``` - -It is returned if the strategyId is invalid. - -### StrategyProtocolFeeTooHigh - -```solidity -error StrategyProtocolFeeTooHigh() -``` - -It is returned if the strategy's protocol fee is too high. - -_It can only be returned for owner operations._ - -### TransferAlreadyInProgress - -```solidity -error TransferAlreadyInProgress() -``` - -This is returned when the transfer is already in progress but the owner tries initiate a new ownership transfer. - -### TransferNotInProgress - -```solidity -error TransferNotInProgress() -``` - -This is returned when there is no ownership transfer in progress but the ownership change tries to be approved. - -### WrongPotentialOwner - -```solidity -error WrongPotentialOwner() -``` - -This is returned when the ownership transfer is attempted to be validated by the a caller that is not the potential owner. diff --git a/docs/docs/developer/api/contracts/marketplace/InheritedStrategy.md b/docs/docs/developer/api/contracts/marketplace/InheritedStrategy.md deleted file mode 100644 index 022cce57..00000000 --- a/docs/docs/developer/api/contracts/marketplace/InheritedStrategy.md +++ /dev/null @@ -1,9 +0,0 @@ -# InheritedStrategy - -_LooksRare protocol team (👀,💎)_ - -> InheritedStrategy - -This contract handles the verification of parameters for standard transactions. It does not verify the taker struct's itemIds and amounts array as well as minPrice (taker ask) / maxPrice (taker bid) because before the taker executes the transaction and the maker itemIds/amounts/price should have already been confirmed off-chain. - -_A standard transaction (bid or ask) is mapped to strategyId = 0._ diff --git a/docs/docs/developer/api/contracts/marketplace/LooksRareProtocol.md b/docs/docs/developer/api/contracts/marketplace/LooksRareProtocol.md deleted file mode 100644 index 66bb61e8..00000000 --- a/docs/docs/developer/api/contracts/marketplace/LooksRareProtocol.md +++ /dev/null @@ -1,1186 +0,0 @@ -# LooksRareProtocol - -_LooksRare protocol team (👀,💎); bitbeckers_ - -> LooksRareProtocol - -This contract is the core smart contract of the LooksRare protocol ("v2"). It is the main entry point for users to initiate transactions with taker orders and manage the cancellation of maker orders, which exist off-chain. ~~~~~~ ~~~~ ~~~~ ~~~ ~~~ ~~~ ~~~ ~~~ ~~~ ~~~~~~~~~ ~~~ ~~~ ~~~~~~~~~ ~~~ ~~~~~~~~~ ~~~~ ~~~~ ~~~~~~~~~ ~~~ ~~~ ~~~~~~~ ~~~~~~~ ~~~ ~~~- ~~~~~~~~ ~~~~ ~~~ ~~~~ ~~~~ ~~~ ~~~ ~~~~~~~~~~~~ ~~~~~~~~~~~~ ~~~ ~~~ ~~~~~~~~~~~ ~~~~~~~~~~~ ~~~ ~~~ ~~~ ~~~ ~~~ ~~~ ~~~ ~~~~~~~~~~ ~~~ ~~~ ~~~~~ ~~~ ~~~~~~ ~~~~~~ ~~~ ~~~~~ ~~~~~~~ ~~~ ~~~ ~~~ ~~~ ~~~~~~~ ~~~~~~ ~~~~ ~~~ ~~~ ~~~~ ~~~~~~ ~~~~ ~~~ ~~~ ~~~ ~~~ ~~~~ ~~~ ~~~ ~~~ ~~~ ~~~ ~~~ ~~~~ ~~~ ~~~ ~~~ ~~~ ~~~~ ~~~~~~ ~~~~ ~~~ ~~~ ~~~~~ ~~~~~~ ~~~~~~~ ~~~ ~~~ ~~~ ~~~ ~~~~~~~ ~~~~~ ~~~ ~~~~~~ ~~~~~~ ~~~ ~~~~~ ~~~ ~~~ ~~~~~~~~~~ ~~~ ~~~ ~~ ~~~ ~~~ ~~~ ~~~ ~~~~~~~~~~~ ~~~~~~~~~~~ ~~~ ~~~ ~~~~~~~~~~~~ ~~~~~~~~~~~~ ~~~ ~~~ ~~~~ ~~~~ ~~~ ~~~~ ~~~~~~~~ ~~~~ ~~~ ~~~~~~~ ~~~~~~~ ~~~ ~~~ ~~~~~~~~ ~~~~ ~~~~ ~~~~~~~~ ~~~ ~~~~~~~~~ ~~~ ~~~ ~~~~~~~~~ ~~~ ~~~ ~~~ ~~~ ~~~ ~~~ ~~~~ ~~~~ ~~~~~~ - -## Methods - -### MAGIC_VALUE_ORDER_NONCE_EXECUTED - -```solidity -function MAGIC_VALUE_ORDER_NONCE_EXECUTED() external view returns (bytes32) -``` - -Magic value nonce returned if executed (or cancelled). - -#### Returns - -| Name | Type | Description | -| ---- | ------- | ----------- | -| \_0 | bytes32 | undefined | - -### WETH - -```solidity -function WETH() external view returns (address) -``` - -Wrapped ETH. - -#### Returns - -| Name | Type | Description | -| ---- | ------- | ----------- | -| \_0 | address | undefined | - -### \_getUnitsHeldByHypercertFractions - -```solidity -function _getUnitsHeldByHypercertFractions(address collection, uint256[] itemIds) external view returns (uint256 unitsHeldByItems) -``` - -#### Parameters - -| Name | Type | Description | -| ---------- | --------- | ----------- | -| collection | address | undefined | -| itemIds | uint256[] | undefined | - -#### Returns - -| Name | Type | Description | -| ---------------- | ------- | ----------- | -| unitsHeldByItems | uint256 | undefined | - -### addStrategy - -```solidity -function addStrategy(uint16 standardProtocolFeeBp, uint16 minTotalFeeBp, uint16 maxProtocolFeeBp, bytes4 selector, bool isMakerBid, address implementation) external nonpayable -``` - -This function allows the owner to add a new execution strategy to the protocol. - -_Strategies have an id that is incremental. Only callable by owner._ - -#### Parameters - -| Name | Type | Description | -| --------------------- | ------- | ---------------------------------------------- | -| standardProtocolFeeBp | uint16 | Standard protocol fee (in basis point) | -| minTotalFeeBp | uint16 | Minimum total fee (in basis point) | -| maxProtocolFeeBp | uint16 | Maximum protocol fee (in basis point) | -| selector | bytes4 | Function selector for the strategy | -| isMakerBid | bool | Whether the function selector is for maker bid | -| implementation | address | Implementation address | - -### cancelOrderNonces - -```solidity -function cancelOrderNonces(uint256[] orderNonces) external nonpayable -``` - -This function allows a user to cancel an array of order nonces. - -_It does not check the status of the nonces to save gas and to prevent revertion if one of the orders is filled in the same block._ - -#### Parameters - -| Name | Type | Description | -| ----------- | --------- | --------------------- | -| orderNonces | uint256[] | Array of order nonces | - -### cancelOwnershipTransfer - -```solidity -function cancelOwnershipTransfer() external nonpayable -``` - -This function is used to cancel the ownership transfer. - -_This function can be used for both cancelling a transfer to a new owner and cancelling the renouncement of the ownership._ - -### cancelSubsetNonces - -```solidity -function cancelSubsetNonces(uint256[] subsetNonces) external nonpayable -``` - -This function allows a user to cancel an array of subset nonces. - -_It does not check the status of the nonces to save gas._ - -#### Parameters - -| Name | Type | Description | -| ------------ | --------- | ---------------------- | -| subsetNonces | uint256[] | Array of subset nonces | - -### chainId - -```solidity -function chainId() external view returns (uint256) -``` - -Current chainId. - -#### Returns - -| Name | Type | Description | -| ---- | ------- | ----------- | -| \_0 | uint256 | undefined | - -### confirmOwnershipRenouncement - -```solidity -function confirmOwnershipRenouncement() external nonpayable -``` - -This function is used to confirm the ownership renouncement. - -### confirmOwnershipTransfer - -```solidity -function confirmOwnershipTransfer() external nonpayable -``` - -This function is used to confirm the ownership transfer. - -_This function can only be called by the current potential owner._ - -### creatorFeeManager - -```solidity -function creatorFeeManager() external view returns (contract ICreatorFeeManager) -``` - -Creator fee manager. - -#### Returns - -| Name | Type | Description | -| ---- | --------------------------- | ----------- | -| \_0 | contract ICreatorFeeManager | undefined | - -### domainSeparator - -```solidity -function domainSeparator() external view returns (bytes32) -``` - -Current domain separator. - -#### Returns - -| Name | Type | Description | -| ---- | ------- | ----------- | -| \_0 | bytes32 | undefined | - -### executeMultipleTakerBids - -```solidity -function executeMultipleTakerBids(OrderStructs.Taker[] takerBids, OrderStructs.Maker[] makerAsks, bytes[] makerSignatures, OrderStructs.MerkleTree[] merkleTrees, bool isAtomic) external payable -``` - -#### Parameters - -| Name | Type | Description | -| --------------- | ------------------------- | ----------- | -| takerBids | OrderStructs.Taker[] | undefined | -| makerAsks | OrderStructs.Maker[] | undefined | -| makerSignatures | bytes[] | undefined | -| merkleTrees | OrderStructs.MerkleTree[] | undefined | -| isAtomic | bool | undefined | - -### executeTakerAsk - -```solidity -function executeTakerAsk(OrderStructs.Taker takerAsk, OrderStructs.Maker makerBid, bytes makerSignature, OrderStructs.MerkleTree merkleTree) external nonpayable -``` - -#### Parameters - -| Name | Type | Description | -| -------------- | ----------------------- | ----------- | -| takerAsk | OrderStructs.Taker | undefined | -| makerBid | OrderStructs.Maker | undefined | -| makerSignature | bytes | undefined | -| merkleTree | OrderStructs.MerkleTree | undefined | - -### executeTakerBid - -```solidity -function executeTakerBid(OrderStructs.Taker takerBid, OrderStructs.Maker makerAsk, bytes makerSignature, OrderStructs.MerkleTree merkleTree) external payable -``` - -#### Parameters - -| Name | Type | Description | -| -------------- | ----------------------- | ----------- | -| takerBid | OrderStructs.Taker | undefined | -| makerAsk | OrderStructs.Maker | undefined | -| makerSignature | bytes | undefined | -| merkleTree | OrderStructs.MerkleTree | undefined | - -### hashBatchOrder - -```solidity -function hashBatchOrder(bytes32 root, uint256 proofLength) external pure returns (bytes32 batchOrderHash) -``` - -This function returns the hash of the concatenation of batch order type hash and merkle root. - -#### Parameters - -| Name | Type | Description | -| ----------- | ------- | ------------------- | -| root | bytes32 | Merkle root | -| proofLength | uint256 | Merkle proof length | - -#### Returns - -| Name | Type | Description | -| -------------- | ------- | -------------------- | -| batchOrderHash | bytes32 | The batch order hash | - -### incrementBidAskNonces - -```solidity -function incrementBidAskNonces(bool bid, bool ask) external nonpayable -``` - -This function increments a user's bid/ask nonces. - -_The logic for computing the quasi-random number is inspired by Seaport v1.2. The pseudo-randomness allows non-deterministic computation of the next ask/bid nonce. A deterministic increment would make the cancel-all process non-effective in certain cases (orders signed with a greater ask/bid nonce). The same quasi-random number is used for incrementing both the bid and ask nonces if both values are incremented in the same transaction. If this function is used twice in the same block, it will return the same quasiRandomNumber but this will not impact the overall business logic._ - -#### Parameters - -| Name | Type | Description | -| ---- | ---- | --------------------------------------- | -| bid | bool | Whether to increment the user bid nonce | -| ask | bool | Whether to increment the user ask nonce | - -### initiateOwnershipRenouncement - -```solidity -function initiateOwnershipRenouncement() external nonpayable -``` - -This function is used to initiate the ownership renouncement. - -### initiateOwnershipTransfer - -```solidity -function initiateOwnershipTransfer(address newPotentialOwner) external nonpayable -``` - -This function is used to initiate the transfer of ownership to a new owner. - -#### Parameters - -| Name | Type | Description | -| ----------------- | ------- | --------------------------- | -| newPotentialOwner | address | New potential owner address | - -### isCurrencyAllowed - -```solidity -function isCurrencyAllowed(address) external view returns (bool) -``` - -It checks whether the currency is allowed for transacting. - -#### Parameters - -| Name | Type | Description | -| ---- | ------- | ----------- | -| \_0 | address | undefined | - -#### Returns - -| Name | Type | Description | -| ---- | ---- | ----------- | -| \_0 | bool | undefined | - -### maxCreatorFeeBp - -```solidity -function maxCreatorFeeBp() external view returns (uint16) -``` - -Maximum creator fee (in basis point). - -#### Returns - -| Name | Type | Description | -| ---- | ------ | ----------- | -| \_0 | uint16 | undefined | - -### owner - -```solidity -function owner() external view returns (address) -``` - -Address of the current owner. - -#### Returns - -| Name | Type | Description | -| ---- | ------- | ----------- | -| \_0 | address | undefined | - -### ownershipStatus - -```solidity -function ownershipStatus() external view returns (enum IOwnableTwoSteps.Status) -``` - -Ownership status. - -#### Returns - -| Name | Type | Description | -| ---- | ---------------------------- | ----------- | -| \_0 | enum IOwnableTwoSteps.Status | undefined | - -### potentialOwner - -```solidity -function potentialOwner() external view returns (address) -``` - -Address of the potential owner. - -#### Returns - -| Name | Type | Description | -| ---- | ------- | ----------- | -| \_0 | address | undefined | - -### protocolFeeRecipient - -```solidity -function protocolFeeRecipient() external view returns (address) -``` - -Protocol fee recipient. - -#### Returns - -| Name | Type | Description | -| ---- | ------- | ----------- | -| \_0 | address | undefined | - -### restrictedExecuteTakerBid - -```solidity -function restrictedExecuteTakerBid(OrderStructs.Taker takerBid, OrderStructs.Maker makerAsk, address sender, bytes32 orderHash) external nonpayable returns (uint256 protocolFeeAmount) -``` - -#### Parameters - -| Name | Type | Description | -| --------- | ------------------ | ----------- | -| takerBid | OrderStructs.Taker | undefined | -| makerAsk | OrderStructs.Maker | undefined | -| sender | address | undefined | -| orderHash | bytes32 | undefined | - -#### Returns - -| Name | Type | Description | -| ----------------- | ------- | ----------- | -| protocolFeeAmount | uint256 | undefined | - -### strategyInfo - -```solidity -function strategyInfo(uint256) external view returns (bool isActive, uint16 standardProtocolFeeBp, uint16 minTotalFeeBp, uint16 maxProtocolFeeBp, bytes4 selector, bool isMakerBid, address implementation) -``` - -This returns the strategy information for a strategy id. - -#### Parameters - -| Name | Type | Description | -| ---- | ------- | ----------- | -| \_0 | uint256 | undefined | - -#### Returns - -| Name | Type | Description | -| --------------------- | ------- | ----------- | -| isActive | bool | undefined | -| standardProtocolFeeBp | uint16 | undefined | -| minTotalFeeBp | uint16 | undefined | -| maxProtocolFeeBp | uint16 | undefined | -| selector | bytes4 | undefined | -| isMakerBid | bool | undefined | -| implementation | address | undefined | - -### transferManager - -```solidity -function transferManager() external view returns (contract TransferManager) -``` - -Transfer manager for ERC721, ERC1155 and Hypercerts. - -#### Returns - -| Name | Type | Description | -| ---- | ------------------------ | ----------- | -| \_0 | contract TransferManager | undefined | - -### updateCreatorFeeManager - -```solidity -function updateCreatorFeeManager(address newCreatorFeeManager) external nonpayable -``` - -This function allows the owner to update the creator fee manager address. - -_Only callable by owner._ - -#### Parameters - -| Name | Type | Description | -| -------------------- | ------- | ---------------------------------- | -| newCreatorFeeManager | address | Address of the creator fee manager | - -### updateCurrencyStatus - -```solidity -function updateCurrencyStatus(address currency, bool isAllowed) external nonpayable -``` - -This function allows the owner to update the status of a currency. - -_Only callable by owner._ - -#### Parameters - -| Name | Type | Description | -| --------- | ------- | -------------------------------------------------- | -| currency | address | Currency address (address(0) for ETH) | -| isAllowed | bool | Whether the currency should be allowed for trading | - -### updateDomainSeparator - -```solidity -function updateDomainSeparator() external nonpayable -``` - -This function allows the owner to update the domain separator (if possible). - -_Only callable by owner. If there is a fork of the network with a new chainId, it allows the owner to reset the domain separator for the new chain id._ - -### updateETHGasLimitForTransfer - -```solidity -function updateETHGasLimitForTransfer(uint256 newGasLimitETHTransfer) external nonpayable -``` - -This function allows the owner to update the maximum ETH gas limit for a standard transfer. - -_Only callable by owner._ - -#### Parameters - -| Name | Type | Description | -| ---------------------- | ------- | ------------------------------ | -| newGasLimitETHTransfer | uint256 | New gas limit for ETH transfer | - -### updateMaxCreatorFeeBp - -```solidity -function updateMaxCreatorFeeBp(uint16 newMaxCreatorFeeBp) external nonpayable -``` - -This function allows the owner to update the maximum creator fee (in basis point). - -_The maximum value that can be set is 25%. Only callable by owner._ - -#### Parameters - -| Name | Type | Description | -| ------------------ | ------ | ---------------------------------------- | -| newMaxCreatorFeeBp | uint16 | New maximum creator fee (in basis point) | - -### updateProtocolFeeRecipient - -```solidity -function updateProtocolFeeRecipient(address newProtocolFeeRecipient) external nonpayable -``` - -This function allows the owner to update the protocol fee recipient. - -_Only callable by owner._ - -#### Parameters - -| Name | Type | Description | -| ----------------------- | ------- | ---------------------------------- | -| newProtocolFeeRecipient | address | New protocol fee recipient address | - -### updateStrategy - -```solidity -function updateStrategy(uint256 strategyId, bool isActive, uint16 newStandardProtocolFee, uint16 newMinTotalFee) external nonpayable -``` - -This function allows the owner to update parameters for an existing execution strategy. - -_Only callable by owner._ - -#### Parameters - -| Name | Type | Description | -| ---------------------- | ------- | ------------------------------------------ | -| strategyId | uint256 | Strategy id | -| isActive | bool | Whether the strategy must be active | -| newStandardProtocolFee | uint16 | New standard protocol fee (in basis point) | -| newMinTotalFee | uint16 | New minimum total fee (in basis point) | - -### userBidAskNonces - -```solidity -function userBidAskNonces(address) external view returns (uint256 bidNonce, uint256 askNonce) -``` - -This tracks the bid and ask nonces for a user address. - -#### Parameters - -| Name | Type | Description | -| ---- | ------- | ----------- | -| \_0 | address | undefined | - -#### Returns - -| Name | Type | Description | -| -------- | ------- | ----------- | -| bidNonce | uint256 | undefined | -| askNonce | uint256 | undefined | - -### userOrderNonce - -```solidity -function userOrderNonce(address, uint256) external view returns (bytes32) -``` - -This checks whether the order nonce for a user was executed or cancelled. - -#### Parameters - -| Name | Type | Description | -| ---- | ------- | ----------- | -| \_0 | address | undefined | -| \_1 | uint256 | undefined | - -#### Returns - -| Name | Type | Description | -| ---- | ------- | ----------- | -| \_0 | bytes32 | undefined | - -### userSubsetNonce - -```solidity -function userSubsetNonce(address, uint256) external view returns (bool) -``` - -This checks whether the subset nonce for a user was cancelled. - -#### Parameters - -| Name | Type | Description | -| ---- | ------- | ----------- | -| \_0 | address | undefined | -| \_1 | uint256 | undefined | - -#### Returns - -| Name | Type | Description | -| ---- | ---- | ----------- | -| \_0 | bool | undefined | - -## Events - -### CancelOwnershipTransfer - -```solidity -event CancelOwnershipTransfer() -``` - -This is emitted if the ownership transfer is cancelled. - -### CurrencyStatusUpdated - -```solidity -event CurrencyStatusUpdated(address currency, bool isAllowed) -``` - -It is emitted if the currency status in the allowlist is updated. - -#### Parameters - -| Name | Type | Description | -| --------- | ------- | ----------- | -| currency | address | undefined | -| isAllowed | bool | undefined | - -### InitiateOwnershipRenouncement - -```solidity -event InitiateOwnershipRenouncement() -``` - -This is emitted if the ownership renouncement is initiated. - -### InitiateOwnershipTransfer - -```solidity -event InitiateOwnershipTransfer(address previousOwner, address potentialOwner) -``` - -This is emitted if the ownership transfer is initiated. - -#### Parameters - -| Name | Type | Description | -| -------------- | ------- | ----------- | -| previousOwner | address | undefined | -| potentialOwner | address | undefined | - -### NewBidAskNonces - -```solidity -event NewBidAskNonces(address user, uint256 bidNonce, uint256 askNonce) -``` - -It is emitted when there is an update of the global bid/ask nonces for a user. - -#### Parameters - -| Name | Type | Description | -| -------- | ------- | ----------- | -| user | address | undefined | -| bidNonce | uint256 | undefined | -| askNonce | uint256 | undefined | - -### NewCreatorFeeManager - -```solidity -event NewCreatorFeeManager(address creatorFeeManager) -``` - -It is issued when there is a new creator fee manager. - -#### Parameters - -| Name | Type | Description | -| ----------------- | ------- | ----------- | -| creatorFeeManager | address | undefined | - -### NewDomainSeparator - -```solidity -event NewDomainSeparator() -``` - -It is emitted if there is a change in the domain separator. - -### NewGasLimitETHTransfer - -```solidity -event NewGasLimitETHTransfer(uint256 gasLimitETHTransfer) -``` - -It is emitted when there is a new gas limit for a ETH transfer (before it is wrapped to WETH). - -#### Parameters - -| Name | Type | Description | -| ------------------- | ------- | ----------- | -| gasLimitETHTransfer | uint256 | undefined | - -### NewMaxCreatorFeeBp - -```solidity -event NewMaxCreatorFeeBp(uint256 maxCreatorFeeBp) -``` - -It is issued when there is a new maximum creator fee (in basis point). - -#### Parameters - -| Name | Type | Description | -| --------------- | ------- | ----------- | -| maxCreatorFeeBp | uint256 | undefined | - -### NewOwner - -```solidity -event NewOwner(address newOwner) -``` - -This is emitted when there is a new owner. - -#### Parameters - -| Name | Type | Description | -| -------- | ------- | ----------- | -| newOwner | address | undefined | - -### NewProtocolFeeRecipient - -```solidity -event NewProtocolFeeRecipient(address protocolFeeRecipient) -``` - -It is issued when there is a new protocol fee recipient address. - -#### Parameters - -| Name | Type | Description | -| -------------------- | ------- | ----------- | -| protocolFeeRecipient | address | undefined | - -### NewStrategy - -```solidity -event NewStrategy(uint256 strategyId, uint16 standardProtocolFeeBp, uint16 minTotalFeeBp, uint16 maxProtocolFeeBp, bytes4 selector, bool isMakerBid, address implementation) -``` - -It is emitted when a new strategy is added. - -#### Parameters - -| Name | Type | Description | -| --------------------- | ------- | ----------- | -| strategyId | uint256 | undefined | -| standardProtocolFeeBp | uint16 | undefined | -| minTotalFeeBp | uint16 | undefined | -| maxProtocolFeeBp | uint16 | undefined | -| selector | bytes4 | undefined | -| isMakerBid | bool | undefined | -| implementation | address | undefined | - -### OrderNoncesCancelled - -```solidity -event OrderNoncesCancelled(address user, uint256[] orderNonces) -``` - -It is emitted when order nonces are cancelled for a user. - -#### Parameters - -| Name | Type | Description | -| ----------- | --------- | ----------- | -| user | address | undefined | -| orderNonces | uint256[] | undefined | - -### StrategyUpdated - -```solidity -event StrategyUpdated(uint256 strategyId, bool isActive, uint16 standardProtocolFeeBp, uint16 minTotalFeeBp) -``` - -It is emitted when an existing strategy is updated. - -#### Parameters - -| Name | Type | Description | -| --------------------- | ------- | ----------- | -| strategyId | uint256 | undefined | -| isActive | bool | undefined | -| standardProtocolFeeBp | uint16 | undefined | -| minTotalFeeBp | uint16 | undefined | - -### SubsetNoncesCancelled - -```solidity -event SubsetNoncesCancelled(address user, uint256[] subsetNonces) -``` - -It is emitted when subset nonces are cancelled for a user. - -#### Parameters - -| Name | Type | Description | -| ------------ | --------- | ----------- | -| user | address | undefined | -| subsetNonces | uint256[] | undefined | - -### TakerAsk - -```solidity -event TakerAsk(ILooksRareProtocol.NonceInvalidationParameters nonceInvalidationParameters, address askUser, address bidUser, uint256 strategyId, address currency, address collection, uint256[] itemIds, uint256[] amounts, address[2] feeRecipients, uint256[3] feeAmounts) -``` - -It is emitted when a taker ask transaction is completed. - -#### Parameters - -| Name | Type | Description | -| --------------------------- | ---------------------------------------------- | ----------- | -| nonceInvalidationParameters | ILooksRareProtocol.NonceInvalidationParameters | undefined | -| askUser | address | undefined | -| bidUser | address | undefined | -| strategyId | uint256 | undefined | -| currency | address | undefined | -| collection | address | undefined | -| itemIds | uint256[] | undefined | -| amounts | uint256[] | undefined | -| feeRecipients | address[2] | undefined | -| feeAmounts | uint256[3] | undefined | - -### TakerBid - -```solidity -event TakerBid(ILooksRareProtocol.NonceInvalidationParameters nonceInvalidationParameters, address bidUser, address bidRecipient, uint256 strategyId, address currency, address collection, uint256[] itemIds, uint256[] amounts, address[2] feeRecipients, uint256[3] feeAmounts) -``` - -It is emitted when a taker bid transaction is completed. - -#### Parameters - -| Name | Type | Description | -| --------------------------- | ---------------------------------------------- | ----------- | -| nonceInvalidationParameters | ILooksRareProtocol.NonceInvalidationParameters | undefined | -| bidUser | address | undefined | -| bidRecipient | address | undefined | -| strategyId | uint256 | undefined | -| currency | address | undefined | -| collection | address | undefined | -| itemIds | uint256[] | undefined | -| amounts | uint256[] | undefined | -| feeRecipients | address[2] | undefined | -| feeAmounts | uint256[3] | undefined | - -## Errors - -### CallerInvalid - -```solidity -error CallerInvalid() -``` - -It is returned if the function cannot be called by the sender. - -### ChainIdInvalid - -```solidity -error ChainIdInvalid() -``` - -It is returned if the domain separator should change. - -### CollectionTypeInvalid - -```solidity -error CollectionTypeInvalid() -``` - -It is returned is the collection type is not supported. For instance if the strategy is specific to hypercerts. - -### CreatorFeeBpTooHigh - -```solidity -error CreatorFeeBpTooHigh() -``` - -It is returned if the creator fee (in basis point) is too high. - -### CurrencyInvalid - -```solidity -error CurrencyInvalid() -``` - -It is returned if the currency is invalid. - -### ERC20TransferFromFail - -```solidity -error ERC20TransferFromFail() -``` - -It is emitted if the ERC20 transferFrom fails. - -### LengthsInvalid - -```solidity -error LengthsInvalid() -``` - -It is returned if there is either a mismatch or an error in the length of the array(s). - -### MerkleProofInvalid - -```solidity -error MerkleProofInvalid() -``` - -It is returned if the merkle proof provided is invalid. - -### MerkleProofTooLarge - -```solidity -error MerkleProofTooLarge(uint256 length) -``` - -It is returned if the length of the merkle proof provided is greater than tolerated. - -#### Parameters - -| Name | Type | Description | -| ------ | ------- | ------------ | -| length | uint256 | Proof length | - -### NewGasLimitETHTransferTooLow - -```solidity -error NewGasLimitETHTransferTooLow() -``` - -It is returned if the gas limit for a standard ETH transfer is too low. - -### NewProtocolFeeRecipientCannotBeNullAddress - -```solidity -error NewProtocolFeeRecipientCannotBeNullAddress() -``` - -It is returned if the new protocol fee recipient is set to address(0). - -### NoOngoingTransferInProgress - -```solidity -error NoOngoingTransferInProgress() -``` - -This is returned when there is no transfer of ownership in progress. - -### NoSelectorForStrategy - -```solidity -error NoSelectorForStrategy() -``` - -It is returned if there is no selector for maker ask/bid for a given strategyId, depending on the quote type. - -### NoncesInvalid - -```solidity -error NoncesInvalid() -``` - -It is returned if the nonces are invalid. - -### NotAContract - -```solidity -error NotAContract() -``` - -It is emitted if the call recipient is not a contract. - -### NotOwner - -```solidity -error NotOwner() -``` - -This is returned when the caller is not the owner. - -### NotV2Strategy - -```solidity -error NotV2Strategy() -``` - -If the strategy has not set properly its implementation contract. - -_It can only be returned for owner operations._ - -### NullSignerAddress - -```solidity -error NullSignerAddress() -``` - -It is emitted if the signer is null. - -### OutsideOfTimeRange - -```solidity -error OutsideOfTimeRange() -``` - -It is returned if the current block timestamp is not between start and end times in the maker order. - -### QuoteTypeInvalid - -```solidity -error QuoteTypeInvalid() -``` - -It is returned if the maker quote type is invalid. - -### ReentrancyFail - -```solidity -error ReentrancyFail() -``` - -This is returned when there is a reentrant call. - -### RenouncementNotInProgress - -```solidity -error RenouncementNotInProgress() -``` - -This is returned when there is no renouncement in progress but the owner tries to validate the ownership renouncement. - -### SameDomainSeparator - -```solidity -error SameDomainSeparator() -``` - -It is returned if the domain separator cannot be updated (i.e. the chainId is the same). - -### SignatureEOAInvalid - -```solidity -error SignatureEOAInvalid() -``` - -It is emitted if the signature is invalid for an EOA (the address recovered is not the expected one). - -### SignatureERC1271Invalid - -```solidity -error SignatureERC1271Invalid() -``` - -It is emitted if the signature is invalid for a ERC1271 contract signer. - -### SignatureLengthInvalid - -```solidity -error SignatureLengthInvalid(uint256 length) -``` - -It is emitted if the signature's length is neither 64 nor 65 bytes. - -#### Parameters - -| Name | Type | Description | -| ------ | ------- | ----------- | -| length | uint256 | undefined | - -### SignatureParameterSInvalid - -```solidity -error SignatureParameterSInvalid() -``` - -It is emitted if the signature is invalid due to S parameter. - -### SignatureParameterVInvalid - -```solidity -error SignatureParameterVInvalid(uint8 v) -``` - -It is emitted if the signature is invalid due to V parameter. - -#### Parameters - -| Name | Type | Description | -| ---- | ----- | ----------- | -| v | uint8 | undefined | - -### StrategyHasNoSelector - -```solidity -error StrategyHasNoSelector() -``` - -It is returned if the strategy has no selector. - -_It can only be returned for owner operations._ - -### StrategyNotAvailable - -```solidity -error StrategyNotAvailable(uint256 strategyId) -``` - -It is returned if the strategy id has no implementation. - -_It is returned if there is no implementation address and the strategyId is strictly greater than 0._ - -#### Parameters - -| Name | Type | Description | -| ---------- | ------- | ----------- | -| strategyId | uint256 | undefined | - -### StrategyNotUsed - -```solidity -error StrategyNotUsed() -``` - -It is returned if the strategyId is invalid. - -### StrategyProtocolFeeTooHigh - -```solidity -error StrategyProtocolFeeTooHigh() -``` - -It is returned if the strategy's protocol fee is too high. - -_It can only be returned for owner operations._ - -### TransferAlreadyInProgress - -```solidity -error TransferAlreadyInProgress() -``` - -This is returned when the transfer is already in progress but the owner tries initiate a new ownership transfer. - -### TransferNotInProgress - -```solidity -error TransferNotInProgress() -``` - -This is returned when there is no ownership transfer in progress but the ownership change tries to be approved. - -### UnitAmountInvalid - -```solidity -error UnitAmountInvalid() -``` - -It is returned if the available amount of fraction units is not available for the selected type of transaction. For instance, a split transaction cannot be executed if the amount of fraction units is not higher than the amount of fraction units available. - -### WrongPotentialOwner - -```solidity -error WrongPotentialOwner() -``` - -This is returned when the ownership transfer is attempted to be validated by the a caller that is not the potential owner. diff --git a/docs/docs/developer/api/contracts/marketplace/NonceManager.md b/docs/docs/developer/api/contracts/marketplace/NonceManager.md deleted file mode 100644 index fea95495..00000000 --- a/docs/docs/developer/api/contracts/marketplace/NonceManager.md +++ /dev/null @@ -1,193 +0,0 @@ -# NonceManager - -_LooksRare protocol team (👀,💎)_ - -> NonceManager - -This contract handles the nonce logic that is used for invalidating maker orders that exist off-chain. The nonce logic revolves around three parts at the user level: - order nonce (orders sharing an order nonce are conditional, OCO-like) - subset (orders can be grouped under a same subset) - bid/ask (all orders can be executed only if the bid/ask nonce matches the user's one on-chain) Only the order nonce is invalidated at the time of the execution of a maker order that contains it. - -## Methods - -### MAGIC_VALUE_ORDER_NONCE_EXECUTED - -```solidity -function MAGIC_VALUE_ORDER_NONCE_EXECUTED() external view returns (bytes32) -``` - -Magic value nonce returned if executed (or cancelled). - -#### Returns - -| Name | Type | Description | -| ---- | ------- | ----------- | -| \_0 | bytes32 | undefined | - -### cancelOrderNonces - -```solidity -function cancelOrderNonces(uint256[] orderNonces) external nonpayable -``` - -This function allows a user to cancel an array of order nonces. - -_It does not check the status of the nonces to save gas and to prevent revertion if one of the orders is filled in the same block._ - -#### Parameters - -| Name | Type | Description | -| ----------- | --------- | --------------------- | -| orderNonces | uint256[] | Array of order nonces | - -### cancelSubsetNonces - -```solidity -function cancelSubsetNonces(uint256[] subsetNonces) external nonpayable -``` - -This function allows a user to cancel an array of subset nonces. - -_It does not check the status of the nonces to save gas._ - -#### Parameters - -| Name | Type | Description | -| ------------ | --------- | ---------------------- | -| subsetNonces | uint256[] | Array of subset nonces | - -### incrementBidAskNonces - -```solidity -function incrementBidAskNonces(bool bid, bool ask) external nonpayable -``` - -This function increments a user's bid/ask nonces. - -_The logic for computing the quasi-random number is inspired by Seaport v1.2. The pseudo-randomness allows non-deterministic computation of the next ask/bid nonce. A deterministic increment would make the cancel-all process non-effective in certain cases (orders signed with a greater ask/bid nonce). The same quasi-random number is used for incrementing both the bid and ask nonces if both values are incremented in the same transaction. If this function is used twice in the same block, it will return the same quasiRandomNumber but this will not impact the overall business logic._ - -#### Parameters - -| Name | Type | Description | -| ---- | ---- | --------------------------------------- | -| bid | bool | Whether to increment the user bid nonce | -| ask | bool | Whether to increment the user ask nonce | - -### userBidAskNonces - -```solidity -function userBidAskNonces(address) external view returns (uint256 bidNonce, uint256 askNonce) -``` - -This tracks the bid and ask nonces for a user address. - -#### Parameters - -| Name | Type | Description | -| ---- | ------- | ----------- | -| \_0 | address | undefined | - -#### Returns - -| Name | Type | Description | -| -------- | ------- | ----------- | -| bidNonce | uint256 | undefined | -| askNonce | uint256 | undefined | - -### userOrderNonce - -```solidity -function userOrderNonce(address, uint256) external view returns (bytes32) -``` - -This checks whether the order nonce for a user was executed or cancelled. - -#### Parameters - -| Name | Type | Description | -| ---- | ------- | ----------- | -| \_0 | address | undefined | -| \_1 | uint256 | undefined | - -#### Returns - -| Name | Type | Description | -| ---- | ------- | ----------- | -| \_0 | bytes32 | undefined | - -### userSubsetNonce - -```solidity -function userSubsetNonce(address, uint256) external view returns (bool) -``` - -This checks whether the subset nonce for a user was cancelled. - -#### Parameters - -| Name | Type | Description | -| ---- | ------- | ----------- | -| \_0 | address | undefined | -| \_1 | uint256 | undefined | - -#### Returns - -| Name | Type | Description | -| ---- | ---- | ----------- | -| \_0 | bool | undefined | - -## Events - -### NewBidAskNonces - -```solidity -event NewBidAskNonces(address user, uint256 bidNonce, uint256 askNonce) -``` - -It is emitted when there is an update of the global bid/ask nonces for a user. - -#### Parameters - -| Name | Type | Description | -| -------- | ------- | ----------- | -| user | address | undefined | -| bidNonce | uint256 | undefined | -| askNonce | uint256 | undefined | - -### OrderNoncesCancelled - -```solidity -event OrderNoncesCancelled(address user, uint256[] orderNonces) -``` - -It is emitted when order nonces are cancelled for a user. - -#### Parameters - -| Name | Type | Description | -| ----------- | --------- | ----------- | -| user | address | undefined | -| orderNonces | uint256[] | undefined | - -### SubsetNoncesCancelled - -```solidity -event SubsetNoncesCancelled(address user, uint256[] subsetNonces) -``` - -It is emitted when subset nonces are cancelled for a user. - -#### Parameters - -| Name | Type | Description | -| ------------ | --------- | ----------- | -| user | address | undefined | -| subsetNonces | uint256[] | undefined | - -## Errors - -### LengthsInvalid - -```solidity -error LengthsInvalid() -``` - -It is returned if there is either a mismatch or an error in the length of the array(s). diff --git a/docs/docs/developer/api/contracts/marketplace/ProtocolFeeRecipient.md b/docs/docs/developer/api/contracts/marketplace/ProtocolFeeRecipient.md deleted file mode 100644 index 36f6a35c..00000000 --- a/docs/docs/developer/api/contracts/marketplace/ProtocolFeeRecipient.md +++ /dev/null @@ -1,75 +0,0 @@ -# ProtocolFeeRecipient - -_LooksRare protocol team (👀,💎)_ - -> ProtocolFeeRecipient - -This contract is used to receive protocol fees and transfer them to the fee sharing setter. Fee sharing setter cannot receive ETH directly, so we need to use this contract as a middleman to convert ETH into WETH before sending it. - -## Methods - -### FEE_SHARING_SETTER - -```solidity -function FEE_SHARING_SETTER() external view returns (address) -``` - -#### Returns - -| Name | Type | Description | -| ---- | ------- | ----------- | -| \_0 | address | undefined | - -### WETH - -```solidity -function WETH() external view returns (contract IWETH) -``` - -#### Returns - -| Name | Type | Description | -| ---- | -------------- | ----------- | -| \_0 | contract IWETH | undefined | - -### transferERC20 - -```solidity -function transferERC20(address currency) external nonpayable -``` - -#### Parameters - -| Name | Type | Description | -| -------- | ------- | ---------------------- | -| currency | address | ERC20 currency address | - -### transferETH - -```solidity -function transferETH() external nonpayable -``` - -## Errors - -### ERC20TransferFail - -```solidity -error ERC20TransferFail() -``` - -It is emitted if the ERC20 transfer fails. - -### NotAContract - -```solidity -error NotAContract() -``` - -It is emitted if the call recipient is not a contract. - -### NothingToTransfer - -```solidity -error NothingToTransfer() -``` diff --git a/docs/docs/developer/api/contracts/marketplace/StrategyManager.md b/docs/docs/developer/api/contracts/marketplace/StrategyManager.md deleted file mode 100644 index a55f3985..00000000 --- a/docs/docs/developer/api/contracts/marketplace/StrategyManager.md +++ /dev/null @@ -1,391 +0,0 @@ -# StrategyManager - -_LooksRare protocol team (👀,💎)_ - -> StrategyManager - -This contract handles the addition and the update of execution strategies. - -## Methods - -### addStrategy - -```solidity -function addStrategy(uint16 standardProtocolFeeBp, uint16 minTotalFeeBp, uint16 maxProtocolFeeBp, bytes4 selector, bool isMakerBid, address implementation) external nonpayable -``` - -This function allows the owner to add a new execution strategy to the protocol. - -_Strategies have an id that is incremental. Only callable by owner._ - -#### Parameters - -| Name | Type | Description | -| --------------------- | ------- | ---------------------------------------------- | -| standardProtocolFeeBp | uint16 | Standard protocol fee (in basis point) | -| minTotalFeeBp | uint16 | Minimum total fee (in basis point) | -| maxProtocolFeeBp | uint16 | Maximum protocol fee (in basis point) | -| selector | bytes4 | Function selector for the strategy | -| isMakerBid | bool | Whether the function selector is for maker bid | -| implementation | address | Implementation address | - -### cancelOwnershipTransfer - -```solidity -function cancelOwnershipTransfer() external nonpayable -``` - -This function is used to cancel the ownership transfer. - -_This function can be used for both cancelling a transfer to a new owner and cancelling the renouncement of the ownership._ - -### confirmOwnershipRenouncement - -```solidity -function confirmOwnershipRenouncement() external nonpayable -``` - -This function is used to confirm the ownership renouncement. - -### confirmOwnershipTransfer - -```solidity -function confirmOwnershipTransfer() external nonpayable -``` - -This function is used to confirm the ownership transfer. - -_This function can only be called by the current potential owner._ - -### initiateOwnershipRenouncement - -```solidity -function initiateOwnershipRenouncement() external nonpayable -``` - -This function is used to initiate the ownership renouncement. - -### initiateOwnershipTransfer - -```solidity -function initiateOwnershipTransfer(address newPotentialOwner) external nonpayable -``` - -This function is used to initiate the transfer of ownership to a new owner. - -#### Parameters - -| Name | Type | Description | -| ----------------- | ------- | --------------------------- | -| newPotentialOwner | address | New potential owner address | - -### isCurrencyAllowed - -```solidity -function isCurrencyAllowed(address) external view returns (bool) -``` - -It checks whether the currency is allowed for transacting. - -#### Parameters - -| Name | Type | Description | -| ---- | ------- | ----------- | -| \_0 | address | undefined | - -#### Returns - -| Name | Type | Description | -| ---- | ---- | ----------- | -| \_0 | bool | undefined | - -### owner - -```solidity -function owner() external view returns (address) -``` - -Address of the current owner. - -#### Returns - -| Name | Type | Description | -| ---- | ------- | ----------- | -| \_0 | address | undefined | - -### ownershipStatus - -```solidity -function ownershipStatus() external view returns (enum IOwnableTwoSteps.Status) -``` - -Ownership status. - -#### Returns - -| Name | Type | Description | -| ---- | ---------------------------- | ----------- | -| \_0 | enum IOwnableTwoSteps.Status | undefined | - -### potentialOwner - -```solidity -function potentialOwner() external view returns (address) -``` - -Address of the potential owner. - -#### Returns - -| Name | Type | Description | -| ---- | ------- | ----------- | -| \_0 | address | undefined | - -### strategyInfo - -```solidity -function strategyInfo(uint256) external view returns (bool isActive, uint16 standardProtocolFeeBp, uint16 minTotalFeeBp, uint16 maxProtocolFeeBp, bytes4 selector, bool isMakerBid, address implementation) -``` - -This returns the strategy information for a strategy id. - -#### Parameters - -| Name | Type | Description | -| ---- | ------- | ----------- | -| \_0 | uint256 | undefined | - -#### Returns - -| Name | Type | Description | -| --------------------- | ------- | ----------- | -| isActive | bool | undefined | -| standardProtocolFeeBp | uint16 | undefined | -| minTotalFeeBp | uint16 | undefined | -| maxProtocolFeeBp | uint16 | undefined | -| selector | bytes4 | undefined | -| isMakerBid | bool | undefined | -| implementation | address | undefined | - -### updateCurrencyStatus - -```solidity -function updateCurrencyStatus(address currency, bool isAllowed) external nonpayable -``` - -This function allows the owner to update the status of a currency. - -_Only callable by owner._ - -#### Parameters - -| Name | Type | Description | -| --------- | ------- | -------------------------------------------------- | -| currency | address | Currency address (address(0) for ETH) | -| isAllowed | bool | Whether the currency should be allowed for trading | - -### updateStrategy - -```solidity -function updateStrategy(uint256 strategyId, bool isActive, uint16 newStandardProtocolFee, uint16 newMinTotalFee) external nonpayable -``` - -This function allows the owner to update parameters for an existing execution strategy. - -_Only callable by owner._ - -#### Parameters - -| Name | Type | Description | -| ---------------------- | ------- | ------------------------------------------ | -| strategyId | uint256 | Strategy id | -| isActive | bool | Whether the strategy must be active | -| newStandardProtocolFee | uint16 | New standard protocol fee (in basis point) | -| newMinTotalFee | uint16 | New minimum total fee (in basis point) | - -## Events - -### CancelOwnershipTransfer - -```solidity -event CancelOwnershipTransfer() -``` - -This is emitted if the ownership transfer is cancelled. - -### CurrencyStatusUpdated - -```solidity -event CurrencyStatusUpdated(address currency, bool isAllowed) -``` - -It is emitted if the currency status in the allowlist is updated. - -#### Parameters - -| Name | Type | Description | -| --------- | ------- | ----------- | -| currency | address | undefined | -| isAllowed | bool | undefined | - -### InitiateOwnershipRenouncement - -```solidity -event InitiateOwnershipRenouncement() -``` - -This is emitted if the ownership renouncement is initiated. - -### InitiateOwnershipTransfer - -```solidity -event InitiateOwnershipTransfer(address previousOwner, address potentialOwner) -``` - -This is emitted if the ownership transfer is initiated. - -#### Parameters - -| Name | Type | Description | -| -------------- | ------- | ----------- | -| previousOwner | address | undefined | -| potentialOwner | address | undefined | - -### NewOwner - -```solidity -event NewOwner(address newOwner) -``` - -This is emitted when there is a new owner. - -#### Parameters - -| Name | Type | Description | -| -------- | ------- | ----------- | -| newOwner | address | undefined | - -### NewStrategy - -```solidity -event NewStrategy(uint256 strategyId, uint16 standardProtocolFeeBp, uint16 minTotalFeeBp, uint16 maxProtocolFeeBp, bytes4 selector, bool isMakerBid, address implementation) -``` - -It is emitted when a new strategy is added. - -#### Parameters - -| Name | Type | Description | -| --------------------- | ------- | ----------- | -| strategyId | uint256 | undefined | -| standardProtocolFeeBp | uint16 | undefined | -| minTotalFeeBp | uint16 | undefined | -| maxProtocolFeeBp | uint16 | undefined | -| selector | bytes4 | undefined | -| isMakerBid | bool | undefined | -| implementation | address | undefined | - -### StrategyUpdated - -```solidity -event StrategyUpdated(uint256 strategyId, bool isActive, uint16 standardProtocolFeeBp, uint16 minTotalFeeBp) -``` - -It is emitted when an existing strategy is updated. - -#### Parameters - -| Name | Type | Description | -| --------------------- | ------- | ----------- | -| strategyId | uint256 | undefined | -| isActive | bool | undefined | -| standardProtocolFeeBp | uint16 | undefined | -| minTotalFeeBp | uint16 | undefined | - -## Errors - -### NoOngoingTransferInProgress - -```solidity -error NoOngoingTransferInProgress() -``` - -This is returned when there is no transfer of ownership in progress. - -### NotOwner - -```solidity -error NotOwner() -``` - -This is returned when the caller is not the owner. - -### NotV2Strategy - -```solidity -error NotV2Strategy() -``` - -If the strategy has not set properly its implementation contract. - -_It can only be returned for owner operations._ - -### RenouncementNotInProgress - -```solidity -error RenouncementNotInProgress() -``` - -This is returned when there is no renouncement in progress but the owner tries to validate the ownership renouncement. - -### StrategyHasNoSelector - -```solidity -error StrategyHasNoSelector() -``` - -It is returned if the strategy has no selector. - -_It can only be returned for owner operations._ - -### StrategyNotUsed - -```solidity -error StrategyNotUsed() -``` - -It is returned if the strategyId is invalid. - -### StrategyProtocolFeeTooHigh - -```solidity -error StrategyProtocolFeeTooHigh() -``` - -It is returned if the strategy's protocol fee is too high. - -_It can only be returned for owner operations._ - -### TransferAlreadyInProgress - -```solidity -error TransferAlreadyInProgress() -``` - -This is returned when the transfer is already in progress but the owner tries initiate a new ownership transfer. - -### TransferNotInProgress - -```solidity -error TransferNotInProgress() -``` - -This is returned when there is no ownership transfer in progress but the ownership change tries to be approved. - -### WrongPotentialOwner - -```solidity -error WrongPotentialOwner() -``` - -This is returned when the ownership transfer is attempted to be validated by the a caller that is not the potential owner. diff --git a/docs/docs/developer/api/contracts/marketplace/TransferManager.md b/docs/docs/developer/api/contracts/marketplace/TransferManager.md deleted file mode 100644 index 991b849c..00000000 --- a/docs/docs/developer/api/contracts/marketplace/TransferManager.md +++ /dev/null @@ -1,561 +0,0 @@ -# TransferManager - -_LooksRare protocol team (👀,💎); bitbeckers_ - -> TransferManager - -This contract provides the transfer functions for ERC721/ERC1155/Hypercert for contracts that require them. Collection type "0" refers to ERC721 transfer functions. Collection type "1" refers to ERC1155 transfer functions. Collection type "2" refers to Hypercert transfer functions. - -_"Safe" transfer functions for ERC721 are not implemented since they come with added gas costs to verify if the recipient is a contract as it requires verifying the receiver interface is valid._ - -## Methods - -### allowOperator - -```solidity -function allowOperator(address operator) external nonpayable -``` - -This function allows an operator to be added for the shared transfer system. Once the operator is allowed, users can grant NFT approvals to this operator. - -_Only callable by owner._ - -#### Parameters - -| Name | Type | Description | -| -------- | ------- | ------------------------- | -| operator | address | Operator address to allow | - -### cancelOwnershipTransfer - -```solidity -function cancelOwnershipTransfer() external nonpayable -``` - -This function is used to cancel the ownership transfer. - -_This function can be used for both cancelling a transfer to a new owner and cancelling the renouncement of the ownership._ - -### confirmOwnershipRenouncement - -```solidity -function confirmOwnershipRenouncement() external nonpayable -``` - -This function is used to confirm the ownership renouncement. - -### confirmOwnershipTransfer - -```solidity -function confirmOwnershipTransfer() external nonpayable -``` - -This function is used to confirm the ownership transfer. - -_This function can only be called by the current potential owner._ - -### grantApprovals - -```solidity -function grantApprovals(address[] operators) external nonpayable -``` - -This function allows a user to grant approvals for an array of operators. Users cannot grant approvals if the operator is not allowed by this contract's owner. - -_Each operator address must be globally allowed to be approved._ - -#### Parameters - -| Name | Type | Description | -| --------- | --------- | --------------------------- | -| operators | address[] | Array of operator addresses | - -### hasUserApprovedOperator - -```solidity -function hasUserApprovedOperator(address, address) external view returns (bool) -``` - -This returns whether the user has approved the operator address. The first address is the user and the second address is the operator (e.g. LooksRareProtocol). - -#### Parameters - -| Name | Type | Description | -| ---- | ------- | ----------- | -| \_0 | address | undefined | -| \_1 | address | undefined | - -#### Returns - -| Name | Type | Description | -| ---- | ---- | ----------- | -| \_0 | bool | undefined | - -### initiateOwnershipRenouncement - -```solidity -function initiateOwnershipRenouncement() external nonpayable -``` - -This function is used to initiate the ownership renouncement. - -### initiateOwnershipTransfer - -```solidity -function initiateOwnershipTransfer(address newPotentialOwner) external nonpayable -``` - -This function is used to initiate the transfer of ownership to a new owner. - -#### Parameters - -| Name | Type | Description | -| ----------------- | ------- | --------------------------- | -| newPotentialOwner | address | New potential owner address | - -### isOperatorAllowed - -```solidity -function isOperatorAllowed(address) external view returns (bool) -``` - -This returns whether the operator address is allowed by this contract's owner. - -#### Parameters - -| Name | Type | Description | -| ---- | ------- | ----------- | -| \_0 | address | undefined | - -#### Returns - -| Name | Type | Description | -| ---- | ---- | ----------- | -| \_0 | bool | undefined | - -### owner - -```solidity -function owner() external view returns (address) -``` - -Address of the current owner. - -#### Returns - -| Name | Type | Description | -| ---- | ------- | ----------- | -| \_0 | address | undefined | - -### ownershipStatus - -```solidity -function ownershipStatus() external view returns (enum IOwnableTwoSteps.Status) -``` - -Ownership status. - -#### Returns - -| Name | Type | Description | -| ---- | ---------------------------- | ----------- | -| \_0 | enum IOwnableTwoSteps.Status | undefined | - -### potentialOwner - -```solidity -function potentialOwner() external view returns (address) -``` - -Address of the potential owner. - -#### Returns - -| Name | Type | Description | -| ---- | ------- | ----------- | -| \_0 | address | undefined | - -### removeOperator - -```solidity -function removeOperator(address operator) external nonpayable -``` - -This function allows the user to remove an operator for the shared transfer system. - -_Only callable by owner._ - -#### Parameters - -| Name | Type | Description | -| -------- | ------- | -------------------------- | -| operator | address | Operator address to remove | - -### revokeApprovals - -```solidity -function revokeApprovals(address[] operators) external nonpayable -``` - -This function allows a user to revoke existing approvals for an array of operators. - -_Each operator address must be approved at the user level to be revoked._ - -#### Parameters - -| Name | Type | Description | -| --------- | --------- | --------------------------- | -| operators | address[] | Array of operator addresses | - -### splitItemsHypercert - -```solidity -function splitItemsHypercert(address collection, address from, address to, uint256[] itemIds, uint256[] amounts) external nonpayable -``` - -This function splits and transfers a fraction of a hypercert. - -_It does not allow batch transferring._ - -#### Parameters - -| Name | Type | Description | -| ---------- | --------- | ------------------ | -| collection | address | Collection address | -| from | address | Sender address | -| to | address | Recipient address | -| itemIds | uint256[] | Array of itemIds | -| amounts | uint256[] | Array of amounts | - -### transferBatchItemsAcrossCollections - -```solidity -function transferBatchItemsAcrossCollections(ITransferManager.BatchTransferItem[] items, address from, address to) external nonpayable -``` - -#### Parameters - -| Name | Type | Description | -| ----- | ------------------------------------ | ----------- | -| items | ITransferManager.BatchTransferItem[] | undefined | -| from | address | undefined | -| to | address | undefined | - -### transferItemsERC1155 - -```solidity -function transferItemsERC1155(address collection, address from, address to, uint256[] itemIds, uint256[] amounts) external nonpayable -``` - -This function transfers items for a single ERC1155 collection. - -_It does not allow batch transferring if from = msg.sender since native function should be used._ - -#### Parameters - -| Name | Type | Description | -| ---------- | --------- | ------------------ | -| collection | address | Collection address | -| from | address | Sender address | -| to | address | Recipient address | -| itemIds | uint256[] | Array of itemIds | -| amounts | uint256[] | Array of amounts | - -### transferItemsERC721 - -```solidity -function transferItemsERC721(address collection, address from, address to, uint256[] itemIds, uint256[] amounts) external nonpayable -``` - -This function transfers items for a single ERC721 collection. - -#### Parameters - -| Name | Type | Description | -| ---------- | --------- | ------------------ | -| collection | address | Collection address | -| from | address | Sender address | -| to | address | Recipient address | -| itemIds | uint256[] | Array of itemIds | -| amounts | uint256[] | Array of amounts | - -### transferItemsHypercert - -```solidity -function transferItemsHypercert(address collection, address from, address to, uint256[] itemIds, uint256[] amounts) external nonpayable -``` - -This function transfers items for a single Hypercert. - -_It does not allow batch transferring if from = msg.sender since native function should be used._ - -#### Parameters - -| Name | Type | Description | -| ---------- | --------- | ------------------ | -| collection | address | Collection address | -| from | address | Sender address | -| to | address | Recipient address | -| itemIds | uint256[] | Array of itemIds | -| amounts | uint256[] | Array of amounts | - -## Events - -### ApprovalsGranted - -```solidity -event ApprovalsGranted(address user, address[] operators) -``` - -It is emitted if operators' approvals to transfer NFTs are granted by a user. - -#### Parameters - -| Name | Type | Description | -| --------- | --------- | ----------- | -| user | address | undefined | -| operators | address[] | undefined | - -### ApprovalsRemoved - -```solidity -event ApprovalsRemoved(address user, address[] operators) -``` - -It is emitted if operators' approvals to transfer NFTs are revoked by a user. - -#### Parameters - -| Name | Type | Description | -| --------- | --------- | ----------- | -| user | address | undefined | -| operators | address[] | undefined | - -### CancelOwnershipTransfer - -```solidity -event CancelOwnershipTransfer() -``` - -This is emitted if the ownership transfer is cancelled. - -### InitiateOwnershipRenouncement - -```solidity -event InitiateOwnershipRenouncement() -``` - -This is emitted if the ownership renouncement is initiated. - -### InitiateOwnershipTransfer - -```solidity -event InitiateOwnershipTransfer(address previousOwner, address potentialOwner) -``` - -This is emitted if the ownership transfer is initiated. - -#### Parameters - -| Name | Type | Description | -| -------------- | ------- | ----------- | -| previousOwner | address | undefined | -| potentialOwner | address | undefined | - -### NewOwner - -```solidity -event NewOwner(address newOwner) -``` - -This is emitted when there is a new owner. - -#### Parameters - -| Name | Type | Description | -| -------- | ------- | ----------- | -| newOwner | address | undefined | - -### OperatorAllowed - -```solidity -event OperatorAllowed(address operator) -``` - -It is emitted if a new operator is added to the global allowlist. - -#### Parameters - -| Name | Type | Description | -| -------- | ------- | ----------- | -| operator | address | undefined | - -### OperatorRemoved - -```solidity -event OperatorRemoved(address operator) -``` - -It is emitted if an operator is removed from the global allowlist. - -#### Parameters - -| Name | Type | Description | -| -------- | ------- | ----------- | -| operator | address | undefined | - -## Errors - -### AmountInvalid - -```solidity -error AmountInvalid() -``` - -It is returned if the amount is invalid. For ERC721 and Hypercert, any number that is not 1. For ERC1155, if amount is 0. - -### ERC1155SafeBatchTransferFromFail - -```solidity -error ERC1155SafeBatchTransferFromFail() -``` - -It is emitted if the ERC1155 safeBatchTransferFrom fails. - -### ERC1155SafeTransferFromFail - -```solidity -error ERC1155SafeTransferFromFail() -``` - -It is emitted if the ERC1155 safeTransferFrom fails. - -### ERC721TransferFromFail - -```solidity -error ERC721TransferFromFail() -``` - -It is emitted if the ERC721 transferFrom fails. - -### HypercertSplitFractionError - -```solidity -error HypercertSplitFractionError() -``` - -### LengthsInvalid - -```solidity -error LengthsInvalid() -``` - -It is returned if there is either a mismatch or an error in the length of the array(s). - -### NoOngoingTransferInProgress - -```solidity -error NoOngoingTransferInProgress() -``` - -This is returned when there is no transfer of ownership in progress. - -### NotAContract - -```solidity -error NotAContract() -``` - -It is emitted if the call recipient is not a contract. - -### NotOwner - -```solidity -error NotOwner() -``` - -This is returned when the caller is not the owner. - -### OperatorAlreadyAllowed - -```solidity -error OperatorAlreadyAllowed() -``` - -It is returned if the transfer caller is already allowed by the owner. - -_This error can only be returned for owner operations._ - -### OperatorAlreadyApprovedByUser - -```solidity -error OperatorAlreadyApprovedByUser() -``` - -It is returned if the operator to approve has already been approved by the user. - -### OperatorNotAllowed - -```solidity -error OperatorNotAllowed() -``` - -It is returned if the operator to approve is not in the global allowlist defined by the owner. - -_This error can be returned if the user tries to grant approval to an operator address not in the allowlist or if the owner tries to remove the operator from the global allowlist._ - -### OperatorNotApprovedByUser - -```solidity -error OperatorNotApprovedByUser() -``` - -It is returned if the operator to revoke has not been previously approved by the user. - -### OrderInvalid - -```solidity -error OrderInvalid() -``` - -It is returned if the order is permanently invalid. There may be an issue with the order formatting. - -### RenouncementNotInProgress - -```solidity -error RenouncementNotInProgress() -``` - -This is returned when there is no renouncement in progress but the owner tries to validate the ownership renouncement. - -### TransferAlreadyInProgress - -```solidity -error TransferAlreadyInProgress() -``` - -This is returned when the transfer is already in progress but the owner tries initiate a new ownership transfer. - -### TransferCallerInvalid - -```solidity -error TransferCallerInvalid() -``` - -It is returned if the transfer caller is invalid. For a transfer called to be valid, the operator must be in the global allowlist and approved by the 'from' user. - -### TransferNotInProgress - -```solidity -error TransferNotInProgress() -``` - -This is returned when there is no ownership transfer in progress but the ownership change tries to be approved. - -### WrongPotentialOwner - -```solidity -error WrongPotentialOwner() -``` - -This is returned when the ownership transfer is attempted to be validated by the a caller that is not the potential owner. diff --git a/docs/docs/developer/api/contracts/marketplace/TransferSelectorNFT.md b/docs/docs/developer/api/contracts/marketplace/TransferSelectorNFT.md deleted file mode 100644 index 168bab88..00000000 --- a/docs/docs/developer/api/contracts/marketplace/TransferSelectorNFT.md +++ /dev/null @@ -1,773 +0,0 @@ -# TransferSelectorNFT - -_LooksRare protocol team (👀,💎); bitbeckers;_ - -> TransferSelectorNFT - -This contract handles the logic for transferring non-fungible items. - -## Methods - -### MAGIC_VALUE_ORDER_NONCE_EXECUTED - -```solidity -function MAGIC_VALUE_ORDER_NONCE_EXECUTED() external view returns (bytes32) -``` - -Magic value nonce returned if executed (or cancelled). - -#### Returns - -| Name | Type | Description | -| ---- | ------- | ----------- | -| \_0 | bytes32 | undefined | - -### addStrategy - -```solidity -function addStrategy(uint16 standardProtocolFeeBp, uint16 minTotalFeeBp, uint16 maxProtocolFeeBp, bytes4 selector, bool isMakerBid, address implementation) external nonpayable -``` - -This function allows the owner to add a new execution strategy to the protocol. - -_Strategies have an id that is incremental. Only callable by owner._ - -#### Parameters - -| Name | Type | Description | -| --------------------- | ------- | ---------------------------------------------- | -| standardProtocolFeeBp | uint16 | Standard protocol fee (in basis point) | -| minTotalFeeBp | uint16 | Minimum total fee (in basis point) | -| maxProtocolFeeBp | uint16 | Maximum protocol fee (in basis point) | -| selector | bytes4 | Function selector for the strategy | -| isMakerBid | bool | Whether the function selector is for maker bid | -| implementation | address | Implementation address | - -### cancelOrderNonces - -```solidity -function cancelOrderNonces(uint256[] orderNonces) external nonpayable -``` - -This function allows a user to cancel an array of order nonces. - -_It does not check the status of the nonces to save gas and to prevent revertion if one of the orders is filled in the same block._ - -#### Parameters - -| Name | Type | Description | -| ----------- | --------- | --------------------- | -| orderNonces | uint256[] | Array of order nonces | - -### cancelOwnershipTransfer - -```solidity -function cancelOwnershipTransfer() external nonpayable -``` - -This function is used to cancel the ownership transfer. - -_This function can be used for both cancelling a transfer to a new owner and cancelling the renouncement of the ownership._ - -### cancelSubsetNonces - -```solidity -function cancelSubsetNonces(uint256[] subsetNonces) external nonpayable -``` - -This function allows a user to cancel an array of subset nonces. - -_It does not check the status of the nonces to save gas._ - -#### Parameters - -| Name | Type | Description | -| ------------ | --------- | ---------------------- | -| subsetNonces | uint256[] | Array of subset nonces | - -### confirmOwnershipRenouncement - -```solidity -function confirmOwnershipRenouncement() external nonpayable -``` - -This function is used to confirm the ownership renouncement. - -### confirmOwnershipTransfer - -```solidity -function confirmOwnershipTransfer() external nonpayable -``` - -This function is used to confirm the ownership transfer. - -_This function can only be called by the current potential owner._ - -### creatorFeeManager - -```solidity -function creatorFeeManager() external view returns (contract ICreatorFeeManager) -``` - -Creator fee manager. - -#### Returns - -| Name | Type | Description | -| ---- | --------------------------- | ----------- | -| \_0 | contract ICreatorFeeManager | undefined | - -### incrementBidAskNonces - -```solidity -function incrementBidAskNonces(bool bid, bool ask) external nonpayable -``` - -This function increments a user's bid/ask nonces. - -_The logic for computing the quasi-random number is inspired by Seaport v1.2. The pseudo-randomness allows non-deterministic computation of the next ask/bid nonce. A deterministic increment would make the cancel-all process non-effective in certain cases (orders signed with a greater ask/bid nonce). The same quasi-random number is used for incrementing both the bid and ask nonces if both values are incremented in the same transaction. If this function is used twice in the same block, it will return the same quasiRandomNumber but this will not impact the overall business logic._ - -#### Parameters - -| Name | Type | Description | -| ---- | ---- | --------------------------------------- | -| bid | bool | Whether to increment the user bid nonce | -| ask | bool | Whether to increment the user ask nonce | - -### initiateOwnershipRenouncement - -```solidity -function initiateOwnershipRenouncement() external nonpayable -``` - -This function is used to initiate the ownership renouncement. - -### initiateOwnershipTransfer - -```solidity -function initiateOwnershipTransfer(address newPotentialOwner) external nonpayable -``` - -This function is used to initiate the transfer of ownership to a new owner. - -#### Parameters - -| Name | Type | Description | -| ----------------- | ------- | --------------------------- | -| newPotentialOwner | address | New potential owner address | - -### isCurrencyAllowed - -```solidity -function isCurrencyAllowed(address) external view returns (bool) -``` - -It checks whether the currency is allowed for transacting. - -#### Parameters - -| Name | Type | Description | -| ---- | ------- | ----------- | -| \_0 | address | undefined | - -#### Returns - -| Name | Type | Description | -| ---- | ---- | ----------- | -| \_0 | bool | undefined | - -### maxCreatorFeeBp - -```solidity -function maxCreatorFeeBp() external view returns (uint16) -``` - -Maximum creator fee (in basis point). - -#### Returns - -| Name | Type | Description | -| ---- | ------ | ----------- | -| \_0 | uint16 | undefined | - -### owner - -```solidity -function owner() external view returns (address) -``` - -Address of the current owner. - -#### Returns - -| Name | Type | Description | -| ---- | ------- | ----------- | -| \_0 | address | undefined | - -### ownershipStatus - -```solidity -function ownershipStatus() external view returns (enum IOwnableTwoSteps.Status) -``` - -Ownership status. - -#### Returns - -| Name | Type | Description | -| ---- | ---------------------------- | ----------- | -| \_0 | enum IOwnableTwoSteps.Status | undefined | - -### potentialOwner - -```solidity -function potentialOwner() external view returns (address) -``` - -Address of the potential owner. - -#### Returns - -| Name | Type | Description | -| ---- | ------- | ----------- | -| \_0 | address | undefined | - -### protocolFeeRecipient - -```solidity -function protocolFeeRecipient() external view returns (address) -``` - -Protocol fee recipient. - -#### Returns - -| Name | Type | Description | -| ---- | ------- | ----------- | -| \_0 | address | undefined | - -### strategyInfo - -```solidity -function strategyInfo(uint256) external view returns (bool isActive, uint16 standardProtocolFeeBp, uint16 minTotalFeeBp, uint16 maxProtocolFeeBp, bytes4 selector, bool isMakerBid, address implementation) -``` - -This returns the strategy information for a strategy id. - -#### Parameters - -| Name | Type | Description | -| ---- | ------- | ----------- | -| \_0 | uint256 | undefined | - -#### Returns - -| Name | Type | Description | -| --------------------- | ------- | ----------- | -| isActive | bool | undefined | -| standardProtocolFeeBp | uint16 | undefined | -| minTotalFeeBp | uint16 | undefined | -| maxProtocolFeeBp | uint16 | undefined | -| selector | bytes4 | undefined | -| isMakerBid | bool | undefined | -| implementation | address | undefined | - -### transferManager - -```solidity -function transferManager() external view returns (contract TransferManager) -``` - -Transfer manager for ERC721, ERC1155 and Hypercerts. - -#### Returns - -| Name | Type | Description | -| ---- | ------------------------ | ----------- | -| \_0 | contract TransferManager | undefined | - -### updateCreatorFeeManager - -```solidity -function updateCreatorFeeManager(address newCreatorFeeManager) external nonpayable -``` - -This function allows the owner to update the creator fee manager address. - -_Only callable by owner._ - -#### Parameters - -| Name | Type | Description | -| -------------------- | ------- | ---------------------------------- | -| newCreatorFeeManager | address | Address of the creator fee manager | - -### updateCurrencyStatus - -```solidity -function updateCurrencyStatus(address currency, bool isAllowed) external nonpayable -``` - -This function allows the owner to update the status of a currency. - -_Only callable by owner._ - -#### Parameters - -| Name | Type | Description | -| --------- | ------- | -------------------------------------------------- | -| currency | address | Currency address (address(0) for ETH) | -| isAllowed | bool | Whether the currency should be allowed for trading | - -### updateMaxCreatorFeeBp - -```solidity -function updateMaxCreatorFeeBp(uint16 newMaxCreatorFeeBp) external nonpayable -``` - -This function allows the owner to update the maximum creator fee (in basis point). - -_The maximum value that can be set is 25%. Only callable by owner._ - -#### Parameters - -| Name | Type | Description | -| ------------------ | ------ | ---------------------------------------- | -| newMaxCreatorFeeBp | uint16 | New maximum creator fee (in basis point) | - -### updateProtocolFeeRecipient - -```solidity -function updateProtocolFeeRecipient(address newProtocolFeeRecipient) external nonpayable -``` - -This function allows the owner to update the protocol fee recipient. - -_Only callable by owner._ - -#### Parameters - -| Name | Type | Description | -| ----------------------- | ------- | ---------------------------------- | -| newProtocolFeeRecipient | address | New protocol fee recipient address | - -### updateStrategy - -```solidity -function updateStrategy(uint256 strategyId, bool isActive, uint16 newStandardProtocolFee, uint16 newMinTotalFee) external nonpayable -``` - -This function allows the owner to update parameters for an existing execution strategy. - -_Only callable by owner._ - -#### Parameters - -| Name | Type | Description | -| ---------------------- | ------- | ------------------------------------------ | -| strategyId | uint256 | Strategy id | -| isActive | bool | Whether the strategy must be active | -| newStandardProtocolFee | uint16 | New standard protocol fee (in basis point) | -| newMinTotalFee | uint16 | New minimum total fee (in basis point) | - -### userBidAskNonces - -```solidity -function userBidAskNonces(address) external view returns (uint256 bidNonce, uint256 askNonce) -``` - -This tracks the bid and ask nonces for a user address. - -#### Parameters - -| Name | Type | Description | -| ---- | ------- | ----------- | -| \_0 | address | undefined | - -#### Returns - -| Name | Type | Description | -| -------- | ------- | ----------- | -| bidNonce | uint256 | undefined | -| askNonce | uint256 | undefined | - -### userOrderNonce - -```solidity -function userOrderNonce(address, uint256) external view returns (bytes32) -``` - -This checks whether the order nonce for a user was executed or cancelled. - -#### Parameters - -| Name | Type | Description | -| ---- | ------- | ----------- | -| \_0 | address | undefined | -| \_1 | uint256 | undefined | - -#### Returns - -| Name | Type | Description | -| ---- | ------- | ----------- | -| \_0 | bytes32 | undefined | - -### userSubsetNonce - -```solidity -function userSubsetNonce(address, uint256) external view returns (bool) -``` - -This checks whether the subset nonce for a user was cancelled. - -#### Parameters - -| Name | Type | Description | -| ---- | ------- | ----------- | -| \_0 | address | undefined | -| \_1 | uint256 | undefined | - -#### Returns - -| Name | Type | Description | -| ---- | ---- | ----------- | -| \_0 | bool | undefined | - -## Events - -### CancelOwnershipTransfer - -```solidity -event CancelOwnershipTransfer() -``` - -This is emitted if the ownership transfer is cancelled. - -### CurrencyStatusUpdated - -```solidity -event CurrencyStatusUpdated(address currency, bool isAllowed) -``` - -It is emitted if the currency status in the allowlist is updated. - -#### Parameters - -| Name | Type | Description | -| --------- | ------- | ----------- | -| currency | address | undefined | -| isAllowed | bool | undefined | - -### InitiateOwnershipRenouncement - -```solidity -event InitiateOwnershipRenouncement() -``` - -This is emitted if the ownership renouncement is initiated. - -### InitiateOwnershipTransfer - -```solidity -event InitiateOwnershipTransfer(address previousOwner, address potentialOwner) -``` - -This is emitted if the ownership transfer is initiated. - -#### Parameters - -| Name | Type | Description | -| -------------- | ------- | ----------- | -| previousOwner | address | undefined | -| potentialOwner | address | undefined | - -### NewBidAskNonces - -```solidity -event NewBidAskNonces(address user, uint256 bidNonce, uint256 askNonce) -``` - -It is emitted when there is an update of the global bid/ask nonces for a user. - -#### Parameters - -| Name | Type | Description | -| -------- | ------- | ----------- | -| user | address | undefined | -| bidNonce | uint256 | undefined | -| askNonce | uint256 | undefined | - -### NewCreatorFeeManager - -```solidity -event NewCreatorFeeManager(address creatorFeeManager) -``` - -It is issued when there is a new creator fee manager. - -#### Parameters - -| Name | Type | Description | -| ----------------- | ------- | ----------- | -| creatorFeeManager | address | undefined | - -### NewMaxCreatorFeeBp - -```solidity -event NewMaxCreatorFeeBp(uint256 maxCreatorFeeBp) -``` - -It is issued when there is a new maximum creator fee (in basis point). - -#### Parameters - -| Name | Type | Description | -| --------------- | ------- | ----------- | -| maxCreatorFeeBp | uint256 | undefined | - -### NewOwner - -```solidity -event NewOwner(address newOwner) -``` - -This is emitted when there is a new owner. - -#### Parameters - -| Name | Type | Description | -| -------- | ------- | ----------- | -| newOwner | address | undefined | - -### NewProtocolFeeRecipient - -```solidity -event NewProtocolFeeRecipient(address protocolFeeRecipient) -``` - -It is issued when there is a new protocol fee recipient address. - -#### Parameters - -| Name | Type | Description | -| -------------------- | ------- | ----------- | -| protocolFeeRecipient | address | undefined | - -### NewStrategy - -```solidity -event NewStrategy(uint256 strategyId, uint16 standardProtocolFeeBp, uint16 minTotalFeeBp, uint16 maxProtocolFeeBp, bytes4 selector, bool isMakerBid, address implementation) -``` - -It is emitted when a new strategy is added. - -#### Parameters - -| Name | Type | Description | -| --------------------- | ------- | ----------- | -| strategyId | uint256 | undefined | -| standardProtocolFeeBp | uint16 | undefined | -| minTotalFeeBp | uint16 | undefined | -| maxProtocolFeeBp | uint16 | undefined | -| selector | bytes4 | undefined | -| isMakerBid | bool | undefined | -| implementation | address | undefined | - -### OrderNoncesCancelled - -```solidity -event OrderNoncesCancelled(address user, uint256[] orderNonces) -``` - -It is emitted when order nonces are cancelled for a user. - -#### Parameters - -| Name | Type | Description | -| ----------- | --------- | ----------- | -| user | address | undefined | -| orderNonces | uint256[] | undefined | - -### StrategyUpdated - -```solidity -event StrategyUpdated(uint256 strategyId, bool isActive, uint16 standardProtocolFeeBp, uint16 minTotalFeeBp) -``` - -It is emitted when an existing strategy is updated. - -#### Parameters - -| Name | Type | Description | -| --------------------- | ------- | ----------- | -| strategyId | uint256 | undefined | -| isActive | bool | undefined | -| standardProtocolFeeBp | uint16 | undefined | -| minTotalFeeBp | uint16 | undefined | - -### SubsetNoncesCancelled - -```solidity -event SubsetNoncesCancelled(address user, uint256[] subsetNonces) -``` - -It is emitted when subset nonces are cancelled for a user. - -#### Parameters - -| Name | Type | Description | -| ------------ | --------- | ----------- | -| user | address | undefined | -| subsetNonces | uint256[] | undefined | - -## Errors - -### CreatorFeeBpTooHigh - -```solidity -error CreatorFeeBpTooHigh() -``` - -It is returned if the creator fee (in basis point) is too high. - -### LengthsInvalid - -```solidity -error LengthsInvalid() -``` - -It is returned if there is either a mismatch or an error in the length of the array(s). - -### NewProtocolFeeRecipientCannotBeNullAddress - -```solidity -error NewProtocolFeeRecipientCannotBeNullAddress() -``` - -It is returned if the new protocol fee recipient is set to address(0). - -### NoOngoingTransferInProgress - -```solidity -error NoOngoingTransferInProgress() -``` - -This is returned when there is no transfer of ownership in progress. - -### NoSelectorForStrategy - -```solidity -error NoSelectorForStrategy() -``` - -It is returned if there is no selector for maker ask/bid for a given strategyId, depending on the quote type. - -### NotOwner - -```solidity -error NotOwner() -``` - -This is returned when the caller is not the owner. - -### NotV2Strategy - -```solidity -error NotV2Strategy() -``` - -If the strategy has not set properly its implementation contract. - -_It can only be returned for owner operations._ - -### OutsideOfTimeRange - -```solidity -error OutsideOfTimeRange() -``` - -It is returned if the current block timestamp is not between start and end times in the maker order. - -### ReentrancyFail - -```solidity -error ReentrancyFail() -``` - -This is returned when there is a reentrant call. - -### RenouncementNotInProgress - -```solidity -error RenouncementNotInProgress() -``` - -This is returned when there is no renouncement in progress but the owner tries to validate the ownership renouncement. - -### StrategyHasNoSelector - -```solidity -error StrategyHasNoSelector() -``` - -It is returned if the strategy has no selector. - -_It can only be returned for owner operations._ - -### StrategyNotAvailable - -```solidity -error StrategyNotAvailable(uint256 strategyId) -``` - -It is returned if the strategy id has no implementation. - -_It is returned if there is no implementation address and the strategyId is strictly greater than 0._ - -#### Parameters - -| Name | Type | Description | -| ---------- | ------- | ----------- | -| strategyId | uint256 | undefined | - -### StrategyNotUsed - -```solidity -error StrategyNotUsed() -``` - -It is returned if the strategyId is invalid. - -### StrategyProtocolFeeTooHigh - -```solidity -error StrategyProtocolFeeTooHigh() -``` - -It is returned if the strategy's protocol fee is too high. - -_It can only be returned for owner operations._ - -### TransferAlreadyInProgress - -```solidity -error TransferAlreadyInProgress() -``` - -This is returned when the transfer is already in progress but the owner tries initiate a new ownership transfer. - -### TransferNotInProgress - -```solidity -error TransferNotInProgress() -``` - -This is returned when there is no ownership transfer in progress but the ownership change tries to be approved. - -### WrongPotentialOwner - -```solidity -error WrongPotentialOwner() -``` - -This is returned when the ownership transfer is attempted to be validated by the a caller that is not the potential owner. diff --git a/docs/docs/developer/api/contracts/marketplace/executionStrategies/BaseStrategy.md b/docs/docs/developer/api/contracts/marketplace/executionStrategies/BaseStrategy.md deleted file mode 100644 index 6767c2c2..00000000 --- a/docs/docs/developer/api/contracts/marketplace/executionStrategies/BaseStrategy.md +++ /dev/null @@ -1,41 +0,0 @@ -# BaseStrategy - -_LooksRare protocol team (👀,💎); bitbeckers_ - -> BaseStrategy - -## Methods - -### isLooksRareV2Strategy - -```solidity -function isLooksRareV2Strategy() external pure returns (bool) -``` - -This function acts as a safety check for the protocol's owner when adding new execution strategies. - -#### Returns - -| Name | Type | Description | -| ---- | ---- | ---------------------------------------------- | -| \_0 | bool | Whether it is a LooksRare V2 protocol strategy | - -### isMakerOrderValid - -```solidity -function isMakerOrderValid(OrderStructs.Maker makerOrder, bytes4 functionSelector) external view returns (bool isValid, bytes4 errorSelector) -``` - -#### Parameters - -| Name | Type | Description | -| ---------------- | ------------------ | ----------- | -| makerOrder | OrderStructs.Maker | undefined | -| functionSelector | bytes4 | undefined | - -#### Returns - -| Name | Type | Description | -| ------------- | ------ | ----------- | -| isValid | bool | undefined | -| errorSelector | bytes4 | undefined | diff --git a/docs/docs/developer/api/contracts/marketplace/executionStrategies/Chainlink/BaseStrategyChainlinkPriceLatency.md b/docs/docs/developer/api/contracts/marketplace/executionStrategies/Chainlink/BaseStrategyChainlinkPriceLatency.md deleted file mode 100644 index c9503939..00000000 --- a/docs/docs/developer/api/contracts/marketplace/executionStrategies/Chainlink/BaseStrategyChainlinkPriceLatency.md +++ /dev/null @@ -1,212 +0,0 @@ -# BaseStrategyChainlinkPriceLatency - -_LooksRare protocol team (👀,💎)_ - -> BaseStrategyChainlinkPriceLatency - -This contract allows the owner to define the maximum acceptable Chainlink price latency. - -## Methods - -### cancelOwnershipTransfer - -```solidity -function cancelOwnershipTransfer() external nonpayable -``` - -This function is used to cancel the ownership transfer. - -_This function can be used for both cancelling a transfer to a new owner and cancelling the renouncement of the ownership._ - -### confirmOwnershipRenouncement - -```solidity -function confirmOwnershipRenouncement() external nonpayable -``` - -This function is used to confirm the ownership renouncement. - -### confirmOwnershipTransfer - -```solidity -function confirmOwnershipTransfer() external nonpayable -``` - -This function is used to confirm the ownership transfer. - -_This function can only be called by the current potential owner._ - -### initiateOwnershipRenouncement - -```solidity -function initiateOwnershipRenouncement() external nonpayable -``` - -This function is used to initiate the ownership renouncement. - -### initiateOwnershipTransfer - -```solidity -function initiateOwnershipTransfer(address newPotentialOwner) external nonpayable -``` - -This function is used to initiate the transfer of ownership to a new owner. - -#### Parameters - -| Name | Type | Description | -| ----------------- | ------- | --------------------------- | -| newPotentialOwner | address | New potential owner address | - -### maxLatency - -```solidity -function maxLatency() external view returns (uint256) -``` - -Maximum latency accepted after which the execution strategy rejects the retrieved price. For ETH, it cannot be higher than 3,600 as Chainlink will at least update the price every 3,600 seconds, provided ETH's price does not deviate more than 0.5%. For NFTs, it cannot be higher than 86,400 as Chainlink will at least update the price every 86,400 seconds, provided ETH's price does not deviate more than 2%. - -#### Returns - -| Name | Type | Description | -| ---- | ------- | ----------- | -| \_0 | uint256 | undefined | - -### owner - -```solidity -function owner() external view returns (address) -``` - -Address of the current owner. - -#### Returns - -| Name | Type | Description | -| ---- | ------- | ----------- | -| \_0 | address | undefined | - -### ownershipStatus - -```solidity -function ownershipStatus() external view returns (enum IOwnableTwoSteps.Status) -``` - -Ownership status. - -#### Returns - -| Name | Type | Description | -| ---- | ---------------------------- | ----------- | -| \_0 | enum IOwnableTwoSteps.Status | undefined | - -### potentialOwner - -```solidity -function potentialOwner() external view returns (address) -``` - -Address of the potential owner. - -#### Returns - -| Name | Type | Description | -| ---- | ------- | ----------- | -| \_0 | address | undefined | - -## Events - -### CancelOwnershipTransfer - -```solidity -event CancelOwnershipTransfer() -``` - -This is emitted if the ownership transfer is cancelled. - -### InitiateOwnershipRenouncement - -```solidity -event InitiateOwnershipRenouncement() -``` - -This is emitted if the ownership renouncement is initiated. - -### InitiateOwnershipTransfer - -```solidity -event InitiateOwnershipTransfer(address previousOwner, address potentialOwner) -``` - -This is emitted if the ownership transfer is initiated. - -#### Parameters - -| Name | Type | Description | -| -------------- | ------- | ----------- | -| previousOwner | address | undefined | -| potentialOwner | address | undefined | - -### NewOwner - -```solidity -event NewOwner(address newOwner) -``` - -This is emitted when there is a new owner. - -#### Parameters - -| Name | Type | Description | -| -------- | ------- | ----------- | -| newOwner | address | undefined | - -## Errors - -### NoOngoingTransferInProgress - -```solidity -error NoOngoingTransferInProgress() -``` - -This is returned when there is no transfer of ownership in progress. - -### NotOwner - -```solidity -error NotOwner() -``` - -This is returned when the caller is not the owner. - -### RenouncementNotInProgress - -```solidity -error RenouncementNotInProgress() -``` - -This is returned when there is no renouncement in progress but the owner tries to validate the ownership renouncement. - -### TransferAlreadyInProgress - -```solidity -error TransferAlreadyInProgress() -``` - -This is returned when the transfer is already in progress but the owner tries initiate a new ownership transfer. - -### TransferNotInProgress - -```solidity -error TransferNotInProgress() -``` - -This is returned when there is no ownership transfer in progress but the ownership change tries to be approved. - -### WrongPotentialOwner - -```solidity -error WrongPotentialOwner() -``` - -This is returned when the ownership transfer is attempted to be validated by the a caller that is not the potential owner. diff --git a/docs/docs/developer/api/contracts/marketplace/executionStrategies/Chainlink/StrategyChainlinkUSDDynamicAsk.md b/docs/docs/developer/api/contracts/marketplace/executionStrategies/Chainlink/StrategyChainlinkUSDDynamicAsk.md deleted file mode 100644 index e2d77dd3..00000000 --- a/docs/docs/developer/api/contracts/marketplace/executionStrategies/Chainlink/StrategyChainlinkUSDDynamicAsk.md +++ /dev/null @@ -1,342 +0,0 @@ -# StrategyChainlinkUSDDynamicAsk - -_LooksRare protocol team (👀,💎)_ - -> StrategyChainlinkUSDDynamicAsk - -This contract allows a seller to sell an NFT priced in USD and the receivable amount to be in ETH. - -## Methods - -### ETH_USD_PRICE_FEED_DECIMALS - -```solidity -function ETH_USD_PRICE_FEED_DECIMALS() external view returns (uint256) -``` - -_It is possible to call priceFeed.decimals() to get the decimals, but to save gas, it is hard coded instead._ - -#### Returns - -| Name | Type | Description | -| ---- | ------- | ----------- | -| \_0 | uint256 | undefined | - -### WETH - -```solidity -function WETH() external view returns (address) -``` - -Wrapped ether (WETH) address. - -#### Returns - -| Name | Type | Description | -| ---- | ------- | ----------- | -| \_0 | address | undefined | - -### cancelOwnershipTransfer - -```solidity -function cancelOwnershipTransfer() external nonpayable -``` - -This function is used to cancel the ownership transfer. - -_This function can be used for both cancelling a transfer to a new owner and cancelling the renouncement of the ownership._ - -### confirmOwnershipRenouncement - -```solidity -function confirmOwnershipRenouncement() external nonpayable -``` - -This function is used to confirm the ownership renouncement. - -### confirmOwnershipTransfer - -```solidity -function confirmOwnershipTransfer() external nonpayable -``` - -This function is used to confirm the ownership transfer. - -_This function can only be called by the current potential owner._ - -### executeStrategyWithTakerBid - -```solidity -function executeStrategyWithTakerBid(OrderStructs.Taker takerBid, OrderStructs.Maker makerAsk) external view returns (uint256 price, uint256[] itemIds, uint256[] amounts, bool isNonceInvalidated) -``` - -#### Parameters - -| Name | Type | Description | -| -------- | ------------------ | ----------- | -| takerBid | OrderStructs.Taker | undefined | -| makerAsk | OrderStructs.Maker | undefined | - -#### Returns - -| Name | Type | Description | -| ------------------ | --------- | ----------- | -| price | uint256 | undefined | -| itemIds | uint256[] | undefined | -| amounts | uint256[] | undefined | -| isNonceInvalidated | bool | undefined | - -### initiateOwnershipRenouncement - -```solidity -function initiateOwnershipRenouncement() external nonpayable -``` - -This function is used to initiate the ownership renouncement. - -### initiateOwnershipTransfer - -```solidity -function initiateOwnershipTransfer(address newPotentialOwner) external nonpayable -``` - -This function is used to initiate the transfer of ownership to a new owner. - -#### Parameters - -| Name | Type | Description | -| ----------------- | ------- | --------------------------- | -| newPotentialOwner | address | New potential owner address | - -### isLooksRareV2Strategy - -```solidity -function isLooksRareV2Strategy() external pure returns (bool) -``` - -This function acts as a safety check for the protocol's owner when adding new execution strategies. - -#### Returns - -| Name | Type | Description | -| ---- | ---- | ---------------------------------------------- | -| \_0 | bool | Whether it is a LooksRare V2 protocol strategy | - -### isMakerOrderValid - -```solidity -function isMakerOrderValid(OrderStructs.Maker makerAsk, bytes4 functionSelector) external view returns (bool isValid, bytes4 errorSelector) -``` - -#### Parameters - -| Name | Type | Description | -| ---------------- | ------------------ | ----------- | -| makerAsk | OrderStructs.Maker | undefined | -| functionSelector | bytes4 | undefined | - -#### Returns - -| Name | Type | Description | -| ------------- | ------ | ----------- | -| isValid | bool | undefined | -| errorSelector | bytes4 | undefined | - -### maxLatency - -```solidity -function maxLatency() external view returns (uint256) -``` - -Maximum latency accepted after which the execution strategy rejects the retrieved price. For ETH, it cannot be higher than 3,600 as Chainlink will at least update the price every 3,600 seconds, provided ETH's price does not deviate more than 0.5%. For NFTs, it cannot be higher than 86,400 as Chainlink will at least update the price every 86,400 seconds, provided ETH's price does not deviate more than 2%. - -#### Returns - -| Name | Type | Description | -| ---- | ------- | ----------- | -| \_0 | uint256 | undefined | - -### owner - -```solidity -function owner() external view returns (address) -``` - -Address of the current owner. - -#### Returns - -| Name | Type | Description | -| ---- | ------- | ----------- | -| \_0 | address | undefined | - -### ownershipStatus - -```solidity -function ownershipStatus() external view returns (enum IOwnableTwoSteps.Status) -``` - -Ownership status. - -#### Returns - -| Name | Type | Description | -| ---- | ---------------------------- | ----------- | -| \_0 | enum IOwnableTwoSteps.Status | undefined | - -### potentialOwner - -```solidity -function potentialOwner() external view returns (address) -``` - -Address of the potential owner. - -#### Returns - -| Name | Type | Description | -| ---- | ------- | ----------- | -| \_0 | address | undefined | - -### priceFeed - -```solidity -function priceFeed() external view returns (contract AggregatorV3Interface) -``` - -ETH/USD Chainlink price feed - -#### Returns - -| Name | Type | Description | -| ---- | ------------------------------ | ----------- | -| \_0 | contract AggregatorV3Interface | undefined | - -## Events - -### CancelOwnershipTransfer - -```solidity -event CancelOwnershipTransfer() -``` - -This is emitted if the ownership transfer is cancelled. - -### InitiateOwnershipRenouncement - -```solidity -event InitiateOwnershipRenouncement() -``` - -This is emitted if the ownership renouncement is initiated. - -### InitiateOwnershipTransfer - -```solidity -event InitiateOwnershipTransfer(address previousOwner, address potentialOwner) -``` - -This is emitted if the ownership transfer is initiated. - -#### Parameters - -| Name | Type | Description | -| -------------- | ------- | ----------- | -| previousOwner | address | undefined | -| potentialOwner | address | undefined | - -### NewOwner - -```solidity -event NewOwner(address newOwner) -``` - -This is emitted when there is a new owner. - -#### Parameters - -| Name | Type | Description | -| -------- | ------- | ----------- | -| newOwner | address | undefined | - -## Errors - -### BidTooLow - -```solidity -error BidTooLow() -``` - -It is returned if the bid price is too low for the ask user. - -### ChainlinkPriceInvalid - -```solidity -error ChainlinkPriceInvalid() -``` - -It is returned if the Chainlink price is invalid (e.g. negative). - -### NoOngoingTransferInProgress - -```solidity -error NoOngoingTransferInProgress() -``` - -This is returned when there is no transfer of ownership in progress. - -### NotOwner - -```solidity -error NotOwner() -``` - -This is returned when the caller is not the owner. - -### OrderInvalid - -```solidity -error OrderInvalid() -``` - -It is returned if the order is permanently invalid. There may be an issue with the order formatting. - -### PriceNotRecentEnough - -```solidity -error PriceNotRecentEnough() -``` - -It is returned if the current block time relative to the latest price's update time is greater than the latency tolerance. - -### RenouncementNotInProgress - -```solidity -error RenouncementNotInProgress() -``` - -This is returned when there is no renouncement in progress but the owner tries to validate the ownership renouncement. - -### TransferAlreadyInProgress - -```solidity -error TransferAlreadyInProgress() -``` - -This is returned when the transfer is already in progress but the owner tries initiate a new ownership transfer. - -### TransferNotInProgress - -```solidity -error TransferNotInProgress() -``` - -This is returned when there is no ownership transfer in progress but the ownership change tries to be approved. - -### WrongPotentialOwner - -```solidity -error WrongPotentialOwner() -``` - -This is returned when the ownership transfer is attempted to be validated by the a caller that is not the potential owner. diff --git a/docs/docs/developer/api/contracts/marketplace/executionStrategies/StrategyCollectionOffer.md b/docs/docs/developer/api/contracts/marketplace/executionStrategies/StrategyCollectionOffer.md deleted file mode 100644 index cecc9324..00000000 --- a/docs/docs/developer/api/contracts/marketplace/executionStrategies/StrategyCollectionOffer.md +++ /dev/null @@ -1,135 +0,0 @@ -# StrategyCollectionOffer - -_LooksRare protocol team (👀,💎); bitbeckers_ - -> StrategyCollectionOffer - -This contract offers execution strategies for users to create maker bid offers for items in a collection. There are two available functions: 1. executeCollectionStrategyWithTakerAsk --> it applies to all itemIds in a collection 2. executeCollectionStrategyWithTakerAskWithProof --> it allows adding merkle proof criteria for tokenIds. 2. executeCollectionStrategyWithTakerAskWithAllowlist --> it allows adding merkle proof criteria for accounts.The bidder can only bid on 1 item id at a time. 1. If ERC721, the amount must be 1. 2. If ERC1155, the amount can be greater than 1. - -## Methods - -### executeCollectionStrategyWithTakerAsk - -```solidity -function executeCollectionStrategyWithTakerAsk(OrderStructs.Taker takerAsk, OrderStructs.Maker makerBid) external pure returns (uint256 price, uint256[] itemIds, uint256[] amounts, bool isNonceInvalidated) -``` - -#### Parameters - -| Name | Type | Description | -| -------- | ------------------ | ----------- | -| takerAsk | OrderStructs.Taker | undefined | -| makerBid | OrderStructs.Maker | undefined | - -#### Returns - -| Name | Type | Description | -| ------------------ | --------- | ----------- | -| price | uint256 | undefined | -| itemIds | uint256[] | undefined | -| amounts | uint256[] | undefined | -| isNonceInvalidated | bool | undefined | - -### executeCollectionStrategyWithTakerAskWithAllowlist - -```solidity -function executeCollectionStrategyWithTakerAskWithAllowlist(OrderStructs.Taker takerAsk, OrderStructs.Maker makerBid) external pure returns (uint256 price, uint256[] itemIds, uint256[] amounts, bool isNonceInvalidated) -``` - -#### Parameters - -| Name | Type | Description | -| -------- | ------------------ | ----------- | -| takerAsk | OrderStructs.Taker | undefined | -| makerBid | OrderStructs.Maker | undefined | - -#### Returns - -| Name | Type | Description | -| ------------------ | --------- | ----------- | -| price | uint256 | undefined | -| itemIds | uint256[] | undefined | -| amounts | uint256[] | undefined | -| isNonceInvalidated | bool | undefined | - -### executeCollectionStrategyWithTakerAskWithProof - -```solidity -function executeCollectionStrategyWithTakerAskWithProof(OrderStructs.Taker takerAsk, OrderStructs.Maker makerBid) external pure returns (uint256 price, uint256[] itemIds, uint256[] amounts, bool isNonceInvalidated) -``` - -#### Parameters - -| Name | Type | Description | -| -------- | ------------------ | ----------- | -| takerAsk | OrderStructs.Taker | undefined | -| makerBid | OrderStructs.Maker | undefined | - -#### Returns - -| Name | Type | Description | -| ------------------ | --------- | ----------- | -| price | uint256 | undefined | -| itemIds | uint256[] | undefined | -| amounts | uint256[] | undefined | -| isNonceInvalidated | bool | undefined | - -### isLooksRareV2Strategy - -```solidity -function isLooksRareV2Strategy() external pure returns (bool) -``` - -This function acts as a safety check for the protocol's owner when adding new execution strategies. - -#### Returns - -| Name | Type | Description | -| ---- | ---- | ---------------------------------------------- | -| \_0 | bool | Whether it is a LooksRare V2 protocol strategy | - -### isMakerOrderValid - -```solidity -function isMakerOrderValid(OrderStructs.Maker makerBid, bytes4 functionSelector) external pure returns (bool isValid, bytes4 errorSelector) -``` - -#### Parameters - -| Name | Type | Description | -| ---------------- | ------------------ | ----------- | -| makerBid | OrderStructs.Maker | undefined | -| functionSelector | bytes4 | undefined | - -#### Returns - -| Name | Type | Description | -| ------------- | ------ | ----------- | -| isValid | bool | undefined | -| errorSelector | bytes4 | undefined | - -## Errors - -### CollectionTypeInvalid - -```solidity -error CollectionTypeInvalid() -``` - -It is returned is the collection type is not supported. For instance if the strategy is specific to hypercerts. - -### MerkleProofInvalid - -```solidity -error MerkleProofInvalid() -``` - -It is returned if the merkle proof provided is invalid. - -### OrderInvalid - -```solidity -error OrderInvalid() -``` - -It is returned if the order is permanently invalid. There may be an issue with the order formatting. diff --git a/docs/docs/developer/api/contracts/marketplace/executionStrategies/StrategyDutchAuction.md b/docs/docs/developer/api/contracts/marketplace/executionStrategies/StrategyDutchAuction.md deleted file mode 100644 index 65fd5b25..00000000 --- a/docs/docs/developer/api/contracts/marketplace/executionStrategies/StrategyDutchAuction.md +++ /dev/null @@ -1,91 +0,0 @@ -# StrategyDutchAuction - -_LooksRare protocol team (👀,💎); bitbeckers_ - -> StrategyDutchAuction - -This contract offers a single execution strategy for users to create Dutch auctions. - -## Methods - -### executeStrategyWithTakerBid - -```solidity -function executeStrategyWithTakerBid(OrderStructs.Taker takerBid, OrderStructs.Maker makerAsk) external view returns (uint256 price, uint256[] itemIds, uint256[] amounts, bool isNonceInvalidated) -``` - -#### Parameters - -| Name | Type | Description | -| -------- | ------------------ | ----------- | -| takerBid | OrderStructs.Taker | undefined | -| makerAsk | OrderStructs.Maker | undefined | - -#### Returns - -| Name | Type | Description | -| ------------------ | --------- | ----------- | -| price | uint256 | undefined | -| itemIds | uint256[] | undefined | -| amounts | uint256[] | undefined | -| isNonceInvalidated | bool | undefined | - -### isLooksRareV2Strategy - -```solidity -function isLooksRareV2Strategy() external pure returns (bool) -``` - -This function acts as a safety check for the protocol's owner when adding new execution strategies. - -#### Returns - -| Name | Type | Description | -| ---- | ---- | ---------------------------------------------- | -| \_0 | bool | Whether it is a LooksRare V2 protocol strategy | - -### isMakerOrderValid - -```solidity -function isMakerOrderValid(OrderStructs.Maker makerAsk, bytes4 functionSelector) external pure returns (bool isValid, bytes4 errorSelector) -``` - -#### Parameters - -| Name | Type | Description | -| ---------------- | ------------------ | ----------- | -| makerAsk | OrderStructs.Maker | undefined | -| functionSelector | bytes4 | undefined | - -#### Returns - -| Name | Type | Description | -| ------------- | ------ | ----------- | -| isValid | bool | undefined | -| errorSelector | bytes4 | undefined | - -## Errors - -### BidTooLow - -```solidity -error BidTooLow() -``` - -It is returned if the bid price is too low for the ask user. - -### CollectionTypeInvalid - -```solidity -error CollectionTypeInvalid() -``` - -It is returned is the collection type is not supported. For instance if the strategy is specific to hypercerts. - -### OrderInvalid - -```solidity -error OrderInvalid() -``` - -It is returned if the order is permanently invalid. There may be an issue with the order formatting. diff --git a/docs/docs/developer/api/contracts/marketplace/executionStrategies/StrategyHypercertCollectionOffer.md b/docs/docs/developer/api/contracts/marketplace/executionStrategies/StrategyHypercertCollectionOffer.md deleted file mode 100644 index 17b10115..00000000 --- a/docs/docs/developer/api/contracts/marketplace/executionStrategies/StrategyHypercertCollectionOffer.md +++ /dev/null @@ -1,135 +0,0 @@ -# StrategyHypercertCollectionOffer - -_LooksRare protocol team (👀,💎); bitbeckers_ - -> StrategyHypercertCollectionOffer - -This contract offers execution strategies for users to create maker bid offers for items in a collection. There are two available functions: 1. executeCollectionStrategyWithTakerAsk --> it applies to all itemIds in a collection 2. executeCollectionStrategyWithTakerAskWithProof --> it allows adding merkle proof criteria for tokenIds. 2. executeCollectionStrategyWithTakerAskWithAllowlist --> it allows adding merkle proof criteria for accounts.The bidder can only bid on 1 item id at a time. 1. The amount must be 1. 2. The units held at bid creation and ask execution time must be the same. 3. The units held by the item sold must be the same as the units held by the item bid. - -## Methods - -### executeHypercertCollectionStrategyWithTakerAsk - -```solidity -function executeHypercertCollectionStrategyWithTakerAsk(OrderStructs.Taker takerAsk, OrderStructs.Maker makerBid) external view returns (uint256 price, uint256[] itemIds, uint256[] amounts, bool isNonceInvalidated) -``` - -#### Parameters - -| Name | Type | Description | -| -------- | ------------------ | ----------- | -| takerAsk | OrderStructs.Taker | undefined | -| makerBid | OrderStructs.Maker | undefined | - -#### Returns - -| Name | Type | Description | -| ------------------ | --------- | ----------- | -| price | uint256 | undefined | -| itemIds | uint256[] | undefined | -| amounts | uint256[] | undefined | -| isNonceInvalidated | bool | undefined | - -### executeHypercertCollectionStrategyWithTakerAskWithAllowlist - -```solidity -function executeHypercertCollectionStrategyWithTakerAskWithAllowlist(OrderStructs.Taker takerAsk, OrderStructs.Maker makerBid) external view returns (uint256 price, uint256[] itemIds, uint256[] amounts, bool isNonceInvalidated) -``` - -#### Parameters - -| Name | Type | Description | -| -------- | ------------------ | ----------- | -| takerAsk | OrderStructs.Taker | undefined | -| makerBid | OrderStructs.Maker | undefined | - -#### Returns - -| Name | Type | Description | -| ------------------ | --------- | ----------- | -| price | uint256 | undefined | -| itemIds | uint256[] | undefined | -| amounts | uint256[] | undefined | -| isNonceInvalidated | bool | undefined | - -### executeHypercertCollectionStrategyWithTakerAskWithProof - -```solidity -function executeHypercertCollectionStrategyWithTakerAskWithProof(OrderStructs.Taker takerAsk, OrderStructs.Maker makerBid) external view returns (uint256 price, uint256[] itemIds, uint256[] amounts, bool isNonceInvalidated) -``` - -#### Parameters - -| Name | Type | Description | -| -------- | ------------------ | ----------- | -| takerAsk | OrderStructs.Taker | undefined | -| makerBid | OrderStructs.Maker | undefined | - -#### Returns - -| Name | Type | Description | -| ------------------ | --------- | ----------- | -| price | uint256 | undefined | -| itemIds | uint256[] | undefined | -| amounts | uint256[] | undefined | -| isNonceInvalidated | bool | undefined | - -### isLooksRareV2Strategy - -```solidity -function isLooksRareV2Strategy() external pure returns (bool) -``` - -This function acts as a safety check for the protocol's owner when adding new execution strategies. - -#### Returns - -| Name | Type | Description | -| ---- | ---- | ---------------------------------------------- | -| \_0 | bool | Whether it is a LooksRare V2 protocol strategy | - -### isMakerOrderValid - -```solidity -function isMakerOrderValid(OrderStructs.Maker makerBid, bytes4 functionSelector) external pure returns (bool isValid, bytes4 errorSelector) -``` - -#### Parameters - -| Name | Type | Description | -| ---------------- | ------------------ | ----------- | -| makerBid | OrderStructs.Maker | undefined | -| functionSelector | bytes4 | undefined | - -#### Returns - -| Name | Type | Description | -| ------------- | ------ | ----------- | -| isValid | bool | undefined | -| errorSelector | bytes4 | undefined | - -## Errors - -### CollectionTypeInvalid - -```solidity -error CollectionTypeInvalid() -``` - -It is returned is the collection type is not supported. For instance if the strategy is specific to hypercerts. - -### MerkleProofInvalid - -```solidity -error MerkleProofInvalid() -``` - -It is returned if the merkle proof provided is invalid. - -### OrderInvalid - -```solidity -error OrderInvalid() -``` - -It is returned if the order is permanently invalid. There may be an issue with the order formatting. diff --git a/docs/docs/developer/api/contracts/marketplace/executionStrategies/StrategyHypercertDutchAuction.md b/docs/docs/developer/api/contracts/marketplace/executionStrategies/StrategyHypercertDutchAuction.md deleted file mode 100644 index a1c37e73..00000000 --- a/docs/docs/developer/api/contracts/marketplace/executionStrategies/StrategyHypercertDutchAuction.md +++ /dev/null @@ -1,91 +0,0 @@ -# StrategyHypercertDutchAuction - -_LooksRare protocol team (👀,💎); bitbeckers_ - -> StrategyHypercertDutchAuction - -This contract offers a single execution strategy for users to create Dutch auctions for hypercerts. - -## Methods - -### executeStrategyWithTakerBid - -```solidity -function executeStrategyWithTakerBid(OrderStructs.Taker takerBid, OrderStructs.Maker makerAsk) external view returns (uint256 price, uint256[] itemIds, uint256[] amounts, bool isNonceInvalidated) -``` - -#### Parameters - -| Name | Type | Description | -| -------- | ------------------ | ----------- | -| takerBid | OrderStructs.Taker | undefined | -| makerAsk | OrderStructs.Maker | undefined | - -#### Returns - -| Name | Type | Description | -| ------------------ | --------- | ----------- | -| price | uint256 | undefined | -| itemIds | uint256[] | undefined | -| amounts | uint256[] | undefined | -| isNonceInvalidated | bool | undefined | - -### isLooksRareV2Strategy - -```solidity -function isLooksRareV2Strategy() external pure returns (bool) -``` - -This function acts as a safety check for the protocol's owner when adding new execution strategies. - -#### Returns - -| Name | Type | Description | -| ---- | ---- | ---------------------------------------------- | -| \_0 | bool | Whether it is a LooksRare V2 protocol strategy | - -### isMakerOrderValid - -```solidity -function isMakerOrderValid(OrderStructs.Maker makerAsk, bytes4 functionSelector) external view returns (bool isValid, bytes4 errorSelector) -``` - -#### Parameters - -| Name | Type | Description | -| ---------------- | ------------------ | ----------- | -| makerAsk | OrderStructs.Maker | undefined | -| functionSelector | bytes4 | undefined | - -#### Returns - -| Name | Type | Description | -| ------------- | ------ | ----------- | -| isValid | bool | undefined | -| errorSelector | bytes4 | undefined | - -## Errors - -### BidTooLow - -```solidity -error BidTooLow() -``` - -It is returned if the bid price is too low for the ask user. - -### CollectionTypeInvalid - -```solidity -error CollectionTypeInvalid() -``` - -It is returned is the collection type is not supported. For instance if the strategy is specific to hypercerts. - -### OrderInvalid - -```solidity -error OrderInvalid() -``` - -It is returned if the order is permanently invalid. There may be an issue with the order formatting. diff --git a/docs/docs/developer/api/contracts/marketplace/executionStrategies/StrategyHypercertFractionOffer.md b/docs/docs/developer/api/contracts/marketplace/executionStrategies/StrategyHypercertFractionOffer.md deleted file mode 100644 index 30b21a56..00000000 --- a/docs/docs/developer/api/contracts/marketplace/executionStrategies/StrategyHypercertFractionOffer.md +++ /dev/null @@ -1,123 +0,0 @@ -# StrategyHypercertFractionOffer - -_LooksRare protocol team (👀,💎); bitbeckers;_ - -> StrategyHypercertFractionOffer - -This contract offers a single execution strategy for users to bid on a specific amount of units in an hypercerts that's for sale. Example: Alice has 100 units of a hypercert (id: 42) for sale at a minimum price of 0.001 ETH/unit. Bob wants to buy 10 units. Bob can create a taker bid order with the following parameters: - unitAmount: 10000 // in `additionalParameters` - pricePerUnit: 10 // amount of accepted token paid; in `additionalParameters` - proof: [0xsdadfa....s9fds,0xdasdas...asff8e] // proof to the root defined in the maker ask; in `additionalParameters` This strategy will validate the available units and the price.This contract offers execution strategies for users to create maker bid offers for items in a collection. There are three available functions: 1. executeHypercertFractionStrategyWithTakerBid --> it applies to all itemIds in a collection 2. executeHypercertFractionStrategyWithTakerBidWithAllowlist --> it allows adding merkle proof criteria for accounts.The bidder can only bid on 1 item id at a time. 1. If Hypercert, the amount must be 1 because the fractions are NFTs. - -_Use cases can include tiered pricing; think early bird tickets._ - -## Methods - -### executeHypercertFractionStrategyWithTakerBid - -```solidity -function executeHypercertFractionStrategyWithTakerBid(OrderStructs.Taker takerBid, OrderStructs.Maker makerAsk) external view returns (uint256 price, uint256[] itemIds, uint256[] amounts, bool isNonceInvalidated) -``` - -#### Parameters - -| Name | Type | Description | -| -------- | ------------------ | ----------- | -| takerBid | OrderStructs.Taker | undefined | -| makerAsk | OrderStructs.Maker | undefined | - -#### Returns - -| Name | Type | Description | -| ------------------ | --------- | ----------- | -| price | uint256 | undefined | -| itemIds | uint256[] | undefined | -| amounts | uint256[] | undefined | -| isNonceInvalidated | bool | undefined | - -### executeHypercertFractionStrategyWithTakerBidWithAllowlist - -```solidity -function executeHypercertFractionStrategyWithTakerBidWithAllowlist(OrderStructs.Taker takerBid, OrderStructs.Maker makerAsk) external view returns (uint256 price, uint256[] itemIds, uint256[] amounts, bool isNonceInvalidated) -``` - -#### Parameters - -| Name | Type | Description | -| -------- | ------------------ | ----------- | -| takerBid | OrderStructs.Taker | undefined | -| makerAsk | OrderStructs.Maker | undefined | - -#### Returns - -| Name | Type | Description | -| ------------------ | --------- | ----------- | -| price | uint256 | undefined | -| itemIds | uint256[] | undefined | -| amounts | uint256[] | undefined | -| isNonceInvalidated | bool | undefined | - -### isLooksRareV2Strategy - -```solidity -function isLooksRareV2Strategy() external pure returns (bool) -``` - -This function acts as a safety check for the protocol's owner when adding new execution strategies. - -#### Returns - -| Name | Type | Description | -| ---- | ---- | ---------------------------------------------- | -| \_0 | bool | Whether it is a LooksRare V2 protocol strategy | - -### isMakerOrderValid - -```solidity -function isMakerOrderValid(OrderStructs.Maker makerAsk, bytes4 functionSelector) external view returns (bool isValid, bytes4 errorSelector) -``` - -#### Parameters - -| Name | Type | Description | -| ---------------- | ------------------ | ----------- | -| makerAsk | OrderStructs.Maker | undefined | -| functionSelector | bytes4 | undefined | - -#### Returns - -| Name | Type | Description | -| ------------- | ------ | ----------- | -| isValid | bool | undefined | -| errorSelector | bytes4 | undefined | - -## Errors - -### AmountInvalid - -```solidity -error AmountInvalid() -``` - -It is returned if the amount is invalid. For ERC721 and Hypercert, any number that is not 1. For ERC1155, if amount is 0. - -### LengthsInvalid - -```solidity -error LengthsInvalid() -``` - -It is returned if there is either a mismatch or an error in the length of the array(s). - -### MerkleProofInvalid - -```solidity -error MerkleProofInvalid() -``` - -It is returned if the merkle proof provided is invalid. - -### OrderInvalid - -```solidity -error OrderInvalid() -``` - -It is returned if the order is permanently invalid. There may be an issue with the order formatting. diff --git a/docs/docs/developer/api/contracts/marketplace/executionStrategies/StrategyItemIdsRange.md b/docs/docs/developer/api/contracts/marketplace/executionStrategies/StrategyItemIdsRange.md deleted file mode 100644 index 6a1f0cd5..00000000 --- a/docs/docs/developer/api/contracts/marketplace/executionStrategies/StrategyItemIdsRange.md +++ /dev/null @@ -1,75 +0,0 @@ -# StrategyItemIdsRange - -_LooksRare protocol team (👀,💎)_ - -> StrategyItemIdsRange - -This contract offers a single execution strategy for users to bid on a specific amount of items in a range bounded by 2 item ids. - -## Methods - -### executeStrategyWithTakerAsk - -```solidity -function executeStrategyWithTakerAsk(OrderStructs.Taker takerAsk, OrderStructs.Maker makerBid) external pure returns (uint256 price, uint256[] itemIds, uint256[] amounts, bool isNonceInvalidated) -``` - -#### Parameters - -| Name | Type | Description | -| -------- | ------------------ | ----------- | -| takerAsk | OrderStructs.Taker | undefined | -| makerBid | OrderStructs.Maker | undefined | - -#### Returns - -| Name | Type | Description | -| ------------------ | --------- | ----------- | -| price | uint256 | undefined | -| itemIds | uint256[] | undefined | -| amounts | uint256[] | undefined | -| isNonceInvalidated | bool | undefined | - -### isLooksRareV2Strategy - -```solidity -function isLooksRareV2Strategy() external pure returns (bool) -``` - -This function acts as a safety check for the protocol's owner when adding new execution strategies. - -#### Returns - -| Name | Type | Description | -| ---- | ---- | ---------------------------------------------- | -| \_0 | bool | Whether it is a LooksRare V2 protocol strategy | - -### isMakerOrderValid - -```solidity -function isMakerOrderValid(OrderStructs.Maker makerBid, bytes4 functionSelector) external pure returns (bool isValid, bytes4 errorSelector) -``` - -#### Parameters - -| Name | Type | Description | -| ---------------- | ------------------ | ----------- | -| makerBid | OrderStructs.Maker | undefined | -| functionSelector | bytes4 | undefined | - -#### Returns - -| Name | Type | Description | -| ------------- | ------ | ----------- | -| isValid | bool | undefined | -| errorSelector | bytes4 | undefined | - -## Errors - -### OrderInvalid - -```solidity -error OrderInvalid() -``` - -It is returned if the order is permanently invalid. There may be an issue with the order formatting. diff --git a/docs/docs/developer/api/contracts/marketplace/helpers/OrderValidatorV2A.md b/docs/docs/developer/api/contracts/marketplace/helpers/OrderValidatorV2A.md deleted file mode 100644 index 76918fc5..00000000 --- a/docs/docs/developer/api/contracts/marketplace/helpers/OrderValidatorV2A.md +++ /dev/null @@ -1,215 +0,0 @@ -# OrderValidatorV2A - -_LooksRare protocol team (👀,💎); bitbeckers_ - -> OrderValidatorV2A - -This contract is used to check the validity of maker ask/bid orders in the LooksRareProtocol (v2). It performs checks for: 1. Protocol allowlist issues (i.e. currency or strategy not allowed) 2. Maker order-specific issues (e.g., order invalid due to format or other-strategy specific issues) 3. Nonce related issues (e.g., nonce executed or cancelled) 4. Signature related issues and merkle tree parameters 5. Timestamp related issues (e.g., order expired) 6. Asset-related issues for ERC20/ERC721/ERC1155/Hypercerts (approvals and balances) 7. Collection-type suggestions 8. Transfer manager related issues 9. Creator fee related issues (e.g., creator fee too high, ERC2981 bundles) - -_This version does not handle strategies with partial fills._ - -## Methods - -### CRITERIA_GROUPS - -```solidity -function CRITERIA_GROUPS() external view returns (uint256) -``` - -Number of distinct criteria groups checked to evaluate the validity of an order. - -#### Returns - -| Name | Type | Description | -| ---- | ------- | ----------- | -| \_0 | uint256 | undefined | - -### ERC1155_INTERFACE_ID - -```solidity -function ERC1155_INTERFACE_ID() external view returns (bytes4) -``` - -ERC1155 interfaceId. - -#### Returns - -| Name | Type | Description | -| ---- | ------ | ----------- | -| \_0 | bytes4 | undefined | - -### ERC721_INTERFACE_ID_1 - -```solidity -function ERC721_INTERFACE_ID_1() external view returns (bytes4) -``` - -ERC721 potential interfaceId. - -#### Returns - -| Name | Type | Description | -| ---- | ------ | ----------- | -| \_0 | bytes4 | undefined | - -### ERC721_INTERFACE_ID_2 - -```solidity -function ERC721_INTERFACE_ID_2() external view returns (bytes4) -``` - -ERC721 potential interfaceId. - -#### Returns - -| Name | Type | Description | -| ---- | ------ | ----------- | -| \_0 | bytes4 | undefined | - -### HYPERCERT_INTERFACE_ID - -```solidity -function HYPERCERT_INTERFACE_ID() external view returns (bytes4) -``` - -Hypercert interfaceId - -#### Returns - -| Name | Type | Description | -| ---- | ------ | ----------- | -| \_0 | bytes4 | undefined | - -### MAGIC_VALUE_ORDER_NONCE_EXECUTED - -```solidity -function MAGIC_VALUE_ORDER_NONCE_EXECUTED() external view returns (bytes32) -``` - -Magic value nonce returned if executed (or cancelled). - -#### Returns - -| Name | Type | Description | -| ---- | ------- | ----------- | -| \_0 | bytes32 | undefined | - -### checkMakerOrderValidity - -```solidity -function checkMakerOrderValidity(OrderStructs.Maker makerOrder, bytes signature, OrderStructs.MerkleTree merkleTree) external view returns (uint256[9] validationCodes) -``` - -#### Parameters - -| Name | Type | Description | -| ---------- | ----------------------- | ----------- | -| makerOrder | OrderStructs.Maker | undefined | -| signature | bytes | undefined | -| merkleTree | OrderStructs.MerkleTree | undefined | - -#### Returns - -| Name | Type | Description | -| --------------- | ---------- | ----------- | -| validationCodes | uint256[9] | undefined | - -### checkMultipleMakerOrderValidities - -```solidity -function checkMultipleMakerOrderValidities(OrderStructs.Maker[] makerOrders, bytes[] signatures, OrderStructs.MerkleTree[] merkleTrees) external view returns (uint256[9][] validationCodes) -``` - -#### Parameters - -| Name | Type | Description | -| ----------- | ------------------------- | ----------- | -| makerOrders | OrderStructs.Maker[] | undefined | -| signatures | bytes[] | undefined | -| merkleTrees | OrderStructs.MerkleTree[] | undefined | - -#### Returns - -| Name | Type | Description | -| --------------- | ------------ | ----------- | -| validationCodes | uint256[9][] | undefined | - -### creatorFeeManager - -```solidity -function creatorFeeManager() external view returns (contract ICreatorFeeManager) -``` - -CreatorFeeManager. - -#### Returns - -| Name | Type | Description | -| ---- | --------------------------- | ----------- | -| \_0 | contract ICreatorFeeManager | undefined | - -### deriveProtocolParameters - -```solidity -function deriveProtocolParameters() external nonpayable -``` - -Derive protocol parameters. Anyone can call this function. - -_It allows adjusting if the domain separator or creator fee manager address were to change._ - -### domainSeparator - -```solidity -function domainSeparator() external view returns (bytes32) -``` - -LooksRareProtocol domain separator. - -#### Returns - -| Name | Type | Description | -| ---- | ------- | ----------- | -| \_0 | bytes32 | undefined | - -### looksRareProtocol - -```solidity -function looksRareProtocol() external view returns (contract LooksRareProtocol) -``` - -LooksRareProtocol. - -#### Returns - -| Name | Type | Description | -| ---- | -------------------------- | ----------- | -| \_0 | contract LooksRareProtocol | undefined | - -### maxCreatorFeeBp - -```solidity -function maxCreatorFeeBp() external view returns (uint256) -``` - -Maximum creator fee (in basis point). - -#### Returns - -| Name | Type | Description | -| ---- | ------- | ----------- | -| \_0 | uint256 | undefined | - -### transferManager - -```solidity -function transferManager() external view returns (contract TransferManager) -``` - -TransferManager - -#### Returns - -| Name | Type | Description | -| ---- | ------------------------ | ----------- | -| \_0 | contract TransferManager | undefined | diff --git a/docs/docs/developer/api/contracts/marketplace/helpers/ProtocolHelpers.md b/docs/docs/developer/api/contracts/marketplace/helpers/ProtocolHelpers.md deleted file mode 100644 index 91be29a9..00000000 --- a/docs/docs/developer/api/contracts/marketplace/helpers/ProtocolHelpers.md +++ /dev/null @@ -1,159 +0,0 @@ -# ProtocolHelpers - -_LooksRare protocol team (👀,💎)_ - -> ProtocolHelpers - -This contract contains helper view functions for order creation. - -## Methods - -### computeDigestMerkleTree - -```solidity -function computeDigestMerkleTree(OrderStructs.MerkleTree merkleTree) external view returns (bytes32 digest) -``` - -#### Parameters - -| Name | Type | Description | -| ---------- | ----------------------- | ----------- | -| merkleTree | OrderStructs.MerkleTree | undefined | - -#### Returns - -| Name | Type | Description | -| ------ | ------- | ----------- | -| digest | bytes32 | undefined | - -### computeMakerDigest - -```solidity -function computeMakerDigest(OrderStructs.Maker maker) external view returns (bytes32 digest) -``` - -#### Parameters - -| Name | Type | Description | -| ----- | ------------------ | ----------- | -| maker | OrderStructs.Maker | undefined | - -#### Returns - -| Name | Type | Description | -| ------ | ------- | ----------- | -| digest | bytes32 | undefined | - -### looksRareProtocol - -```solidity -function looksRareProtocol() external view returns (contract LooksRareProtocol) -``` - -#### Returns - -| Name | Type | Description | -| ---- | -------------------------- | ----------- | -| \_0 | contract LooksRareProtocol | undefined | - -### verifyMakerSignature - -```solidity -function verifyMakerSignature(OrderStructs.Maker maker, bytes makerSignature, address signer) external view returns (bool) -``` - -#### Parameters - -| Name | Type | Description | -| -------------- | ------------------ | ----------- | -| maker | OrderStructs.Maker | undefined | -| makerSignature | bytes | undefined | -| signer | address | undefined | - -#### Returns - -| Name | Type | Description | -| ---- | ---- | ----------- | -| \_0 | bool | undefined | - -### verifyMerkleTree - -```solidity -function verifyMerkleTree(OrderStructs.MerkleTree merkleTree, bytes makerSignature, address signer) external view returns (bool) -``` - -#### Parameters - -| Name | Type | Description | -| -------------- | ----------------------- | ----------- | -| merkleTree | OrderStructs.MerkleTree | undefined | -| makerSignature | bytes | undefined | -| signer | address | undefined | - -#### Returns - -| Name | Type | Description | -| ---- | ---- | ----------- | -| \_0 | bool | undefined | - -## Errors - -### NullSignerAddress - -```solidity -error NullSignerAddress() -``` - -It is emitted if the signer is null. - -### SignatureEOAInvalid - -```solidity -error SignatureEOAInvalid() -``` - -It is emitted if the signature is invalid for an EOA (the address recovered is not the expected one). - -### SignatureERC1271Invalid - -```solidity -error SignatureERC1271Invalid() -``` - -It is emitted if the signature is invalid for a ERC1271 contract signer. - -### SignatureLengthInvalid - -```solidity -error SignatureLengthInvalid(uint256 length) -``` - -It is emitted if the signature's length is neither 64 nor 65 bytes. - -#### Parameters - -| Name | Type | Description | -| ------ | ------- | ----------- | -| length | uint256 | undefined | - -### SignatureParameterSInvalid - -```solidity -error SignatureParameterSInvalid() -``` - -It is emitted if the signature is invalid due to S parameter. - -### SignatureParameterVInvalid - -```solidity -error SignatureParameterVInvalid(uint8 v) -``` - -It is emitted if the signature is invalid due to V parameter. - -#### Parameters - -| Name | Type | Description | -| ---- | ----- | ----------- | -| v | uint8 | undefined | diff --git a/docs/docs/developer/api/contracts/marketplace/interfaces/ICreatorFeeManager.md b/docs/docs/developer/api/contracts/marketplace/interfaces/ICreatorFeeManager.md deleted file mode 100644 index b832744e..00000000 --- a/docs/docs/developer/api/contracts/marketplace/interfaces/ICreatorFeeManager.md +++ /dev/null @@ -1,60 +0,0 @@ -# ICreatorFeeManager - -_LooksRare protocol team (👀,💎)_ - -> ICreatorFeeManager - -## Methods - -### royaltyFeeRegistry - -```solidity -function royaltyFeeRegistry() external view returns (contract IRoyaltyFeeRegistry royaltyFeeRegistry) -``` - -It returns the royalty fee registry address/interface. - -#### Returns - -| Name | Type | Description | -| ------------------ | ---------------------------- | ------------------------------------- | -| royaltyFeeRegistry | contract IRoyaltyFeeRegistry | Interface of the royalty fee registry | - -### viewCreatorFeeInfo - -```solidity -function viewCreatorFeeInfo(address collection, uint256 price, uint256[] itemIds) external view returns (address creator, uint256 creatorFeeAmount) -``` - -This function returns the creator address and calculates the creator fee amount. - -#### Parameters - -| Name | Type | Description | -| ---------- | --------- | ------------------ | -| collection | address | Collection address | -| price | uint256 | Transaction price | -| itemIds | uint256[] | Array of item ids | - -#### Returns - -| Name | Type | Description | -| ---------------- | ------- | ------------------ | -| creator | address | Creator address | -| creatorFeeAmount | uint256 | Creator fee amount | - -## Errors - -### BundleEIP2981NotAllowed - -```solidity -error BundleEIP2981NotAllowed(address collection) -``` - -It is returned if the bundle contains multiple itemIds with different creator fee structure. - -#### Parameters - -| Name | Type | Description | -| ---------- | ------- | ----------- | -| collection | address | undefined | diff --git a/docs/docs/developer/api/contracts/marketplace/interfaces/ICurrencyManager.md b/docs/docs/developer/api/contracts/marketplace/interfaces/ICurrencyManager.md deleted file mode 100644 index da683d8c..00000000 --- a/docs/docs/developer/api/contracts/marketplace/interfaces/ICurrencyManager.md +++ /dev/null @@ -1,22 +0,0 @@ -# ICurrencyManager - -_LooksRare protocol team (👀,💎)_ - -> ICurrencyManager - -## Events - -### CurrencyStatusUpdated - -```solidity -event CurrencyStatusUpdated(address currency, bool isAllowed) -``` - -It is emitted if the currency status in the allowlist is updated. - -#### Parameters - -| Name | Type | Description | -| --------- | ------- | ----------------------------------- | -| currency | address | Currency address (address(0) = ETH) | -| isAllowed | bool | Whether the currency is allowed | diff --git a/docs/docs/developer/api/contracts/marketplace/interfaces/IExecutionManager.md b/docs/docs/developer/api/contracts/marketplace/interfaces/IExecutionManager.md deleted file mode 100644 index 0e86c75b..00000000 --- a/docs/docs/developer/api/contracts/marketplace/interfaces/IExecutionManager.md +++ /dev/null @@ -1,99 +0,0 @@ -# IExecutionManager - -_LooksRare protocol team (👀,💎)_ - -> IExecutionManager - -## Events - -### NewCreatorFeeManager - -```solidity -event NewCreatorFeeManager(address creatorFeeManager) -``` - -It is issued when there is a new creator fee manager. - -#### Parameters - -| Name | Type | Description | -| ----------------- | ------- | -------------------------------------- | -| creatorFeeManager | address | Address of the new creator fee manager | - -### NewMaxCreatorFeeBp - -```solidity -event NewMaxCreatorFeeBp(uint256 maxCreatorFeeBp) -``` - -It is issued when there is a new maximum creator fee (in basis point). - -#### Parameters - -| Name | Type | Description | -| --------------- | ------- | ---------------------------------------- | -| maxCreatorFeeBp | uint256 | New maximum creator fee (in basis point) | - -### NewProtocolFeeRecipient - -```solidity -event NewProtocolFeeRecipient(address protocolFeeRecipient) -``` - -It is issued when there is a new protocol fee recipient address. - -#### Parameters - -| Name | Type | Description | -| -------------------- | ------- | ----------------------------------------- | -| protocolFeeRecipient | address | Address of the new protocol fee recipient | - -## Errors - -### CreatorFeeBpTooHigh - -```solidity -error CreatorFeeBpTooHigh() -``` - -It is returned if the creator fee (in basis point) is too high. - -### NewProtocolFeeRecipientCannotBeNullAddress - -```solidity -error NewProtocolFeeRecipientCannotBeNullAddress() -``` - -It is returned if the new protocol fee recipient is set to address(0). - -### NoSelectorForStrategy - -```solidity -error NoSelectorForStrategy() -``` - -It is returned if there is no selector for maker ask/bid for a given strategyId, depending on the quote type. - -### OutsideOfTimeRange - -```solidity -error OutsideOfTimeRange() -``` - -It is returned if the current block timestamp is not between start and end times in the maker order. - -### StrategyNotAvailable - -```solidity -error StrategyNotAvailable(uint256 strategyId) -``` - -It is returned if the strategy id has no implementation. - -_It is returned if there is no implementation address and the strategyId is strictly greater than 0._ - -#### Parameters - -| Name | Type | Description | -| ---------- | ------- | ----------- | -| strategyId | uint256 | undefined | diff --git a/docs/docs/developer/api/contracts/marketplace/interfaces/IHypercert1155Token.md b/docs/docs/developer/api/contracts/marketplace/interfaces/IHypercert1155Token.md deleted file mode 100644 index 249c98d8..00000000 --- a/docs/docs/developer/api/contracts/marketplace/interfaces/IHypercert1155Token.md +++ /dev/null @@ -1,72 +0,0 @@ -# IHypercert1155Token - -## Methods - -### isApprovedForAll - -```solidity -function isApprovedForAll(address account, address operator) external view returns (bool) -``` - -#### Parameters - -| Name | Type | Description | -| -------- | ------- | ----------- | -| account | address | undefined | -| operator | address | undefined | - -#### Returns - -| Name | Type | Description | -| ---- | ---- | ----------- | -| \_0 | bool | undefined | - -### ownerOf - -```solidity -function ownerOf(uint256 tokenId) external view returns (address) -``` - -#### Parameters - -| Name | Type | Description | -| ------- | ------- | ----------- | -| tokenId | uint256 | undefined | - -#### Returns - -| Name | Type | Description | -| ---- | ------- | ----------- | -| \_0 | address | undefined | - -### splitFraction - -```solidity -function splitFraction(address to, uint256 tokenID, uint256[] _values) external nonpayable -``` - -#### Parameters - -| Name | Type | Description | -| -------- | --------- | ----------- | -| to | address | undefined | -| tokenID | uint256 | undefined | -| \_values | uint256[] | undefined | - -### unitsOf - -```solidity -function unitsOf(uint256 tokenId) external view returns (uint256) -``` - -#### Parameters - -| Name | Type | Description | -| ------- | ------- | ----------- | -| tokenId | uint256 | undefined | - -#### Returns - -| Name | Type | Description | -| ---- | ------- | ----------- | -| \_0 | uint256 | undefined | diff --git a/docs/docs/developer/api/contracts/marketplace/interfaces/IImmutableCreate2Factory.md b/docs/docs/developer/api/contracts/marketplace/interfaces/IImmutableCreate2Factory.md deleted file mode 100644 index 393cb24b..00000000 --- a/docs/docs/developer/api/contracts/marketplace/interfaces/IImmutableCreate2Factory.md +++ /dev/null @@ -1,41 +0,0 @@ -# IImmutableCreate2Factory - -## Methods - -### findCreate2Address - -```solidity -function findCreate2Address(bytes32 salt, bytes initializationCode) external view returns (address deploymentAddress) -``` - -#### Parameters - -| Name | Type | Description | -| ------------------ | ------- | ----------- | -| salt | bytes32 | undefined | -| initializationCode | bytes | undefined | - -#### Returns - -| Name | Type | Description | -| ----------------- | ------- | ----------- | -| deploymentAddress | address | undefined | - -### safeCreate2 - -```solidity -function safeCreate2(bytes32 salt, bytes initializationCode) external payable returns (address deploymentAddress) -``` - -#### Parameters - -| Name | Type | Description | -| ------------------ | ------- | ----------- | -| salt | bytes32 | undefined | -| initializationCode | bytes | undefined | - -#### Returns - -| Name | Type | Description | -| ----------------- | ------- | ----------- | -| deploymentAddress | address | undefined | diff --git a/docs/docs/developer/api/contracts/marketplace/interfaces/ILooksRareProtocol.md b/docs/docs/developer/api/contracts/marketplace/interfaces/ILooksRareProtocol.md deleted file mode 100644 index e7414f54..00000000 --- a/docs/docs/developer/api/contracts/marketplace/interfaces/ILooksRareProtocol.md +++ /dev/null @@ -1,157 +0,0 @@ -# ILooksRareProtocol - -_LooksRare protocol team (👀,💎)_ - -> ILooksRareProtocol - -## Methods - -### executeMultipleTakerBids - -```solidity -function executeMultipleTakerBids(OrderStructs.Taker[] takerBids, OrderStructs.Maker[] makerAsks, bytes[] makerSignatures, OrderStructs.MerkleTree[] merkleTrees, bool isAtomic) external payable -``` - -#### Parameters - -| Name | Type | Description | -| --------------- | ------------------------- | ----------- | -| takerBids | OrderStructs.Taker[] | undefined | -| makerAsks | OrderStructs.Maker[] | undefined | -| makerSignatures | bytes[] | undefined | -| merkleTrees | OrderStructs.MerkleTree[] | undefined | -| isAtomic | bool | undefined | - -### executeTakerAsk - -```solidity -function executeTakerAsk(OrderStructs.Taker takerAsk, OrderStructs.Maker makerBid, bytes makerSignature, OrderStructs.MerkleTree merkleTree) external nonpayable -``` - -#### Parameters - -| Name | Type | Description | -| -------------- | ----------------------- | ----------- | -| takerAsk | OrderStructs.Taker | undefined | -| makerBid | OrderStructs.Maker | undefined | -| makerSignature | bytes | undefined | -| merkleTree | OrderStructs.MerkleTree | undefined | - -### executeTakerBid - -```solidity -function executeTakerBid(OrderStructs.Taker takerBid, OrderStructs.Maker makerAsk, bytes makerSignature, OrderStructs.MerkleTree merkleTree) external payable -``` - -#### Parameters - -| Name | Type | Description | -| -------------- | ----------------------- | ----------- | -| takerBid | OrderStructs.Taker | undefined | -| makerAsk | OrderStructs.Maker | undefined | -| makerSignature | bytes | undefined | -| merkleTree | OrderStructs.MerkleTree | undefined | - -## Events - -### NewDomainSeparator - -```solidity -event NewDomainSeparator() -``` - -It is emitted if there is a change in the domain separator. - -### NewGasLimitETHTransfer - -```solidity -event NewGasLimitETHTransfer(uint256 gasLimitETHTransfer) -``` - -It is emitted when there is a new gas limit for a ETH transfer (before it is wrapped to WETH). - -#### Parameters - -| Name | Type | Description | -| ------------------- | ------- | ----------------------------- | -| gasLimitETHTransfer | uint256 | Gas limit for an ETH transfer | - -### TakerAsk - -```solidity -event TakerAsk(ILooksRareProtocol.NonceInvalidationParameters nonceInvalidationParameters, address askUser, address bidUser, uint256 strategyId, address currency, address collection, uint256[] itemIds, uint256[] amounts, address[2] feeRecipients, uint256[3] feeAmounts) -``` - -It is emitted when a taker ask transaction is completed. - -#### Parameters - -| Name | Type | Description | -| --------------------------- | ---------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| nonceInvalidationParameters | ILooksRareProtocol.NonceInvalidationParameters | Struct about nonce invalidation parameters | -| askUser | address | Address of the ask user | -| bidUser | address | Address of the bid user | -| strategyId | uint256 | Id of the strategy | -| currency | address | Address of the currency | -| collection | address | Address of the collection | -| itemIds | uint256[] | Array of item ids | -| amounts | uint256[] | Array of amounts (for item ids) | -| feeRecipients | address[2] | Array of fee recipients feeRecipients[0] User who receives the proceeds of the sale (it can be the taker ask user or different) feeRecipients[1] Creator fee recipient (if none, address(0)) | -| feeAmounts | uint256[3] | Array of fee amounts feeAmounts[0] Fee amount for the user receiving sale proceeds feeAmounts[1] Creator fee amount feeAmounts[2] Protocol fee amount prior to adjustment for a potential affiliate payment | - -### TakerBid - -```solidity -event TakerBid(ILooksRareProtocol.NonceInvalidationParameters nonceInvalidationParameters, address bidUser, address bidRecipient, uint256 strategyId, address currency, address collection, uint256[] itemIds, uint256[] amounts, address[2] feeRecipients, uint256[3] feeAmounts) -``` - -It is emitted when a taker bid transaction is completed. - -#### Parameters - -| Name | Type | Description | -| --------------------------- | ---------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| nonceInvalidationParameters | ILooksRareProtocol.NonceInvalidationParameters | Struct about nonce invalidation parameters | -| bidUser | address | Address of the bid user | -| bidRecipient | address | Address of the recipient of the bid | -| strategyId | uint256 | Id of the strategy | -| currency | address | Address of the currency | -| collection | address | Address of the collection | -| itemIds | uint256[] | Array of item ids | -| amounts | uint256[] | Array of amounts (for item ids) | -| feeRecipients | address[2] | Array of fee recipients feeRecipients[0] User who receives the proceeds of the sale (it is the maker ask user) feeRecipients[1] Creator fee recipient (if none, address(0)) | -| feeAmounts | uint256[3] | Array of fee amounts feeAmounts[0] Fee amount for the user receiving sale proceeds feeAmounts[1] Creator fee amount feeAmounts[2] Protocol fee amount prior to adjustment for a potential affiliate payment | - -## Errors - -### ChainIdInvalid - -```solidity -error ChainIdInvalid() -``` - -It is returned if the domain separator should change. - -### NewGasLimitETHTransferTooLow - -```solidity -error NewGasLimitETHTransferTooLow() -``` - -It is returned if the gas limit for a standard ETH transfer is too low. - -### NoncesInvalid - -```solidity -error NoncesInvalid() -``` - -It is returned if the nonces are invalid. - -### SameDomainSeparator - -```solidity -error SameDomainSeparator() -``` - -It is returned if the domain separator cannot be updated (i.e. the chainId is the same). diff --git a/docs/docs/developer/api/contracts/marketplace/interfaces/INonceManager.md b/docs/docs/developer/api/contracts/marketplace/interfaces/INonceManager.md deleted file mode 100644 index eaa3f977..00000000 --- a/docs/docs/developer/api/contracts/marketplace/interfaces/INonceManager.md +++ /dev/null @@ -1,53 +0,0 @@ -# INonceManager - -_LooksRare protocol team (👀,💎)_ - -> INonceManager - -## Events - -### NewBidAskNonces - -```solidity -event NewBidAskNonces(address user, uint256 bidNonce, uint256 askNonce) -``` - -It is emitted when there is an update of the global bid/ask nonces for a user. - -#### Parameters - -| Name | Type | Description | -| -------- | ------- | ------------------- | -| user | address | Address of the user | -| bidNonce | uint256 | New bid nonce | -| askNonce | uint256 | New ask nonce | - -### OrderNoncesCancelled - -```solidity -event OrderNoncesCancelled(address user, uint256[] orderNonces) -``` - -It is emitted when order nonces are cancelled for a user. - -#### Parameters - -| Name | Type | Description | -| ----------- | --------- | ------------------------------- | -| user | address | Address of the user | -| orderNonces | uint256[] | Array of order nonces cancelled | - -### SubsetNoncesCancelled - -```solidity -event SubsetNoncesCancelled(address user, uint256[] subsetNonces) -``` - -It is emitted when subset nonces are cancelled for a user. - -#### Parameters - -| Name | Type | Description | -| ------------ | --------- | -------------------------------- | -| user | address | Address of the user | -| subsetNonces | uint256[] | Array of subset nonces cancelled | diff --git a/docs/docs/developer/api/contracts/marketplace/interfaces/IRoyaltyFeeRegistry.md b/docs/docs/developer/api/contracts/marketplace/interfaces/IRoyaltyFeeRegistry.md deleted file mode 100644 index 5ed0ef6c..00000000 --- a/docs/docs/developer/api/contracts/marketplace/interfaces/IRoyaltyFeeRegistry.md +++ /dev/null @@ -1,29 +0,0 @@ -# IRoyaltyFeeRegistry - -_LooksRare protocol team (👀,💎)_ - -> IRoyaltyFeeRegistry - -## Methods - -### royaltyInfo - -```solidity -function royaltyInfo(address collection, uint256 price) external view returns (address receiver, uint256 royaltyFee) -``` - -This function returns the royalty information for a collection at a given transaction price. - -#### Parameters - -| Name | Type | Description | -| ---------- | ------- | ------------------ | -| collection | address | Collection address | -| price | uint256 | Transaction price | - -#### Returns - -| Name | Type | Description | -| ---------- | ------- | ------------------ | -| receiver | address | Receiver address | -| royaltyFee | uint256 | Royalty fee amount | diff --git a/docs/docs/developer/api/contracts/marketplace/interfaces/IStrategy.md b/docs/docs/developer/api/contracts/marketplace/interfaces/IStrategy.md deleted file mode 100644 index 2b4a45bc..00000000 --- a/docs/docs/developer/api/contracts/marketplace/interfaces/IStrategy.md +++ /dev/null @@ -1,41 +0,0 @@ -# IStrategy - -_LooksRare protocol team (👀,💎)_ - -> IStrategy - -## Methods - -### isLooksRareV2Strategy - -```solidity -function isLooksRareV2Strategy() external pure returns (bool isStrategy) -``` - -This function acts as a safety check for the protocol's owner when adding new execution strategies. - -#### Returns - -| Name | Type | Description | -| ---------- | ---- | ---------------------------------------------- | -| isStrategy | bool | Whether it is a LooksRare V2 protocol strategy | - -### isMakerOrderValid - -```solidity -function isMakerOrderValid(OrderStructs.Maker makerOrder, bytes4 functionSelector) external view returns (bool isValid, bytes4 errorSelector) -``` - -#### Parameters - -| Name | Type | Description | -| ---------------- | ------------------ | ----------- | -| makerOrder | OrderStructs.Maker | undefined | -| functionSelector | bytes4 | undefined | - -#### Returns - -| Name | Type | Description | -| ------------- | ------ | ----------- | -| isValid | bool | undefined | -| errorSelector | bytes4 | undefined | diff --git a/docs/docs/developer/api/contracts/marketplace/interfaces/IStrategyManager.md b/docs/docs/developer/api/contracts/marketplace/interfaces/IStrategyManager.md deleted file mode 100644 index ae6ea7b1..00000000 --- a/docs/docs/developer/api/contracts/marketplace/interfaces/IStrategyManager.md +++ /dev/null @@ -1,84 +0,0 @@ -# IStrategyManager - -_LooksRare protocol team (👀,💎)_ - -> IStrategyManager - -## Events - -### NewStrategy - -```solidity -event NewStrategy(uint256 strategyId, uint16 standardProtocolFeeBp, uint16 minTotalFeeBp, uint16 maxProtocolFeeBp, bytes4 selector, bool isMakerBid, address implementation) -``` - -It is emitted when a new strategy is added. - -#### Parameters - -| Name | Type | Description | -| --------------------- | ------- | ---------------------------------------------------- | -| strategyId | uint256 | Id of the new strategy | -| standardProtocolFeeBp | uint16 | Standard protocol fee (in basis point) | -| minTotalFeeBp | uint16 | Minimum total fee (in basis point) | -| maxProtocolFeeBp | uint16 | Maximum protocol fee (in basis point) | -| selector | bytes4 | Function selector for the transaction to be executed | -| isMakerBid | bool | Whether the strategyId is for maker bid | -| implementation | address | Address of the implementation of the strategy | - -### StrategyUpdated - -```solidity -event StrategyUpdated(uint256 strategyId, bool isActive, uint16 standardProtocolFeeBp, uint16 minTotalFeeBp) -``` - -It is emitted when an existing strategy is updated. - -#### Parameters - -| Name | Type | Description | -| --------------------- | ------- | -------------------------------------------------------- | -| strategyId | uint256 | Id of the strategy | -| isActive | bool | Whether the strategy is active (or not) after the update | -| standardProtocolFeeBp | uint16 | Standard protocol fee (in basis point) | -| minTotalFeeBp | uint16 | Minimum total fee (in basis point) | - -## Errors - -### NotV2Strategy - -```solidity -error NotV2Strategy() -``` - -If the strategy has not set properly its implementation contract. - -_It can only be returned for owner operations._ - -### StrategyHasNoSelector - -```solidity -error StrategyHasNoSelector() -``` - -It is returned if the strategy has no selector. - -_It can only be returned for owner operations._ - -### StrategyNotUsed - -```solidity -error StrategyNotUsed() -``` - -It is returned if the strategyId is invalid. - -### StrategyProtocolFeeTooHigh - -```solidity -error StrategyProtocolFeeTooHigh() -``` - -It is returned if the strategy's protocol fee is too high. - -_It can only be returned for owner operations._ diff --git a/docs/docs/developer/api/contracts/marketplace/interfaces/ITransferManager.md b/docs/docs/developer/api/contracts/marketplace/interfaces/ITransferManager.md deleted file mode 100644 index 3ba8ca81..00000000 --- a/docs/docs/developer/api/contracts/marketplace/interfaces/ITransferManager.md +++ /dev/null @@ -1,111 +0,0 @@ -# ITransferManager - -_LooksRare protocol team (👀,💎)_ - -> ITransferManager - -## Events - -### ApprovalsGranted - -```solidity -event ApprovalsGranted(address user, address[] operators) -``` - -It is emitted if operators' approvals to transfer NFTs are granted by a user. - -#### Parameters - -| Name | Type | Description | -| --------- | --------- | --------------------------- | -| user | address | Address of the user | -| operators | address[] | Array of operator addresses | - -### ApprovalsRemoved - -```solidity -event ApprovalsRemoved(address user, address[] operators) -``` - -It is emitted if operators' approvals to transfer NFTs are revoked by a user. - -#### Parameters - -| Name | Type | Description | -| --------- | --------- | --------------------------- | -| user | address | Address of the user | -| operators | address[] | Array of operator addresses | - -### OperatorAllowed - -```solidity -event OperatorAllowed(address operator) -``` - -It is emitted if a new operator is added to the global allowlist. - -#### Parameters - -| Name | Type | Description | -| -------- | ------- | ---------------- | -| operator | address | Operator address | - -### OperatorRemoved - -```solidity -event OperatorRemoved(address operator) -``` - -It is emitted if an operator is removed from the global allowlist. - -#### Parameters - -| Name | Type | Description | -| -------- | ------- | ---------------- | -| operator | address | Operator address | - -## Errors - -### OperatorAlreadyAllowed - -```solidity -error OperatorAlreadyAllowed() -``` - -It is returned if the transfer caller is already allowed by the owner. - -_This error can only be returned for owner operations._ - -### OperatorAlreadyApprovedByUser - -```solidity -error OperatorAlreadyApprovedByUser() -``` - -It is returned if the operator to approve has already been approved by the user. - -### OperatorNotAllowed - -```solidity -error OperatorNotAllowed() -``` - -It is returned if the operator to approve is not in the global allowlist defined by the owner. - -_This error can be returned if the user tries to grant approval to an operator address not in the allowlist or if the owner tries to remove the operator from the global allowlist._ - -### OperatorNotApprovedByUser - -```solidity -error OperatorNotApprovedByUser() -``` - -It is returned if the operator to revoke has not been previously approved by the user. - -### TransferCallerInvalid - -```solidity -error TransferCallerInvalid() -``` - -It is returned if the transfer caller is invalid. For a transfer called to be valid, the operator must be in the global allowlist and approved by the 'from' user. diff --git a/docs/docs/developer/api/contracts/marketplace/libraries/CurrencyValidator.md b/docs/docs/developer/api/contracts/marketplace/libraries/CurrencyValidator.md deleted file mode 100644 index 1b1f41a2..00000000 --- a/docs/docs/developer/api/contracts/marketplace/libraries/CurrencyValidator.md +++ /dev/null @@ -1,7 +0,0 @@ -# CurrencyValidator - -_LooksRare protocol team (👀,💎)_ - -> CurrencyValidator - -This library validates the order currency to be the chain's native currency or the specified ERC20 token. diff --git a/docs/docs/developer/api/contracts/marketplace/libraries/LowLevelHypercertCaller.md b/docs/docs/developer/api/contracts/marketplace/libraries/LowLevelHypercertCaller.md deleted file mode 100644 index 5951cc56..00000000 --- a/docs/docs/developer/api/contracts/marketplace/libraries/LowLevelHypercertCaller.md +++ /dev/null @@ -1,21 +0,0 @@ -# LowLevelHypercertCaller - -_bitbeckers_ - -> LowLevelHypercertCaller - -This contract contains low-level calls to transfer ERC1155 tokens. - -## Errors - -### HypercertSplitFractionError - -```solidity -error HypercertSplitFractionError() -``` - -### NotAContract - -```solidity -error NotAContract() -``` diff --git a/docs/docs/developer/api/contracts/marketplace/libraries/OpenZeppelin/MerkleProofCalldataWithNodes.md b/docs/docs/developer/api/contracts/marketplace/libraries/OpenZeppelin/MerkleProofCalldataWithNodes.md deleted file mode 100644 index 943a54cd..00000000 --- a/docs/docs/developer/api/contracts/marketplace/libraries/OpenZeppelin/MerkleProofCalldataWithNodes.md +++ /dev/null @@ -1,7 +0,0 @@ -# MerkleProofCalldataWithNodes - -_OpenZeppelin (adjusted by LooksRare)_ - -> MerkleProofCalldataWithNodes - -This library is adjusted from the work of OpenZeppelin. It is based on the 4.7.0 (utils/cryptography/MerkleProof.sol). diff --git a/docs/docs/developer/api/contracts/marketplace/libraries/OpenZeppelin/MerkleProofMemory.md b/docs/docs/developer/api/contracts/marketplace/libraries/OpenZeppelin/MerkleProofMemory.md deleted file mode 100644 index 37529181..00000000 --- a/docs/docs/developer/api/contracts/marketplace/libraries/OpenZeppelin/MerkleProofMemory.md +++ /dev/null @@ -1,7 +0,0 @@ -# MerkleProofMemory - -_OpenZeppelin (adjusted by LooksRare)_ - -> MerkleProofMemory - -This library is adjusted from the work of OpenZeppelin. It is based on the 4.7.0 (utils/cryptography/MerkleProof.sol). diff --git a/docs/docs/developer/api/contracts/marketplace/libraries/OrderStructs.md b/docs/docs/developer/api/contracts/marketplace/libraries/OrderStructs.md deleted file mode 100644 index 6ffa83e2..00000000 --- a/docs/docs/developer/api/contracts/marketplace/libraries/OrderStructs.md +++ /dev/null @@ -1,7 +0,0 @@ -# OrderStructs - -_LooksRare protocol team (👀,💎); bitbeckers_ - -> OrderStructs - -This library contains all order struct types for the LooksRare protocol (v2). diff --git a/docs/docs/developer/api/contracts/marketplace/libraries/RoyaltyFeeRegistry.md b/docs/docs/developer/api/contracts/marketplace/libraries/RoyaltyFeeRegistry.md deleted file mode 100644 index 781ab041..00000000 --- a/docs/docs/developer/api/contracts/marketplace/libraries/RoyaltyFeeRegistry.md +++ /dev/null @@ -1,172 +0,0 @@ -# RoyaltyFeeRegistry - -> RoyaltyFeeRegistry - -It is a royalty fee registry for the LooksRare exchange. - -## Methods - -### owner - -```solidity -function owner() external view returns (address) -``` - -_Returns the address of the current owner._ - -#### Returns - -| Name | Type | Description | -| ---- | ------- | ----------- | -| \_0 | address | undefined | - -### renounceOwnership - -```solidity -function renounceOwnership() external nonpayable -``` - -_Leaves the contract without owner. It will not be possible to call `onlyOwner` functions. Can only be called by the current owner. NOTE: Renouncing ownership will leave the contract without an owner, thereby disabling any functionality that is only available to the owner._ - -### royaltyFeeInfoCollection - -```solidity -function royaltyFeeInfoCollection(address collection) external view returns (address, address, uint256) -``` - -View royalty info for a collection address - -#### Parameters - -| Name | Type | Description | -| ---------- | ------- | ------------------ | -| collection | address | collection address | - -#### Returns - -| Name | Type | Description | -| ---- | ------- | ----------- | -| \_0 | address | undefined | -| \_1 | address | undefined | -| \_2 | uint256 | undefined | - -### royaltyFeeLimit - -```solidity -function royaltyFeeLimit() external view returns (uint256) -``` - -#### Returns - -| Name | Type | Description | -| ---- | ------- | ----------- | -| \_0 | uint256 | undefined | - -### royaltyInfo - -```solidity -function royaltyInfo(address collection, uint256 amount) external view returns (address, uint256) -``` - -Calculate royalty info for a collection address and a sale gross amount - -#### Parameters - -| Name | Type | Description | -| ---------- | ------- | ------------------ | -| collection | address | collection address | -| amount | uint256 | amount | - -#### Returns - -| Name | Type | Description | -| ---- | ------- | --------------------------------------------------------- | -| \_0 | address | receiver address and amount received by royalty recipient | -| \_1 | uint256 | undefined | - -### transferOwnership - -```solidity -function transferOwnership(address newOwner) external nonpayable -``` - -_Transfers ownership of the contract to a new account (`newOwner`). Can only be called by the current owner._ - -#### Parameters - -| Name | Type | Description | -| -------- | ------- | ----------- | -| newOwner | address | undefined | - -### updateRoyaltyFeeLimit - -```solidity -function updateRoyaltyFeeLimit(uint256 _royaltyFeeLimit) external nonpayable -``` - -Update royalty info for collection - -#### Parameters - -| Name | Type | Description | -| ----------------- | ------- | --------------------------------------------- | -| \_royaltyFeeLimit | uint256 | new royalty fee limit (500 = 5%, 1,000 = 10%) | - -### updateRoyaltyInfoForCollection - -```solidity -function updateRoyaltyInfoForCollection(address collection, address setter, address receiver, uint256 fee) external nonpayable -``` - -Update royalty info for collection - -#### Parameters - -| Name | Type | Description | -| ---------- | ------- | ------------------------------ | -| collection | address | address of the NFT contract | -| setter | address | address that sets the receiver | -| receiver | address | receiver for the royalty fee | -| fee | uint256 | fee (500 = 5%, 1,000 = 10%) | - -## Events - -### NewRoyaltyFeeLimit - -```solidity -event NewRoyaltyFeeLimit(uint256 royaltyFeeLimit) -``` - -#### Parameters - -| Name | Type | Description | -| --------------- | ------- | ----------- | -| royaltyFeeLimit | uint256 | undefined | - -### OwnershipTransferred - -```solidity -event OwnershipTransferred(address indexed previousOwner, address indexed newOwner) -``` - -#### Parameters - -| Name | Type | Description | -| ----------------------- | ------- | ----------- | -| previousOwner `indexed` | address | undefined | -| newOwner `indexed` | address | undefined | - -### RoyaltyFeeUpdate - -```solidity -event RoyaltyFeeUpdate(address indexed collection, address indexed setter, address indexed receiver, uint256 fee) -``` - -#### Parameters - -| Name | Type | Description | -| -------------------- | ------- | ----------- | -| collection `indexed` | address | undefined | -| setter `indexed` | address | undefined | -| receiver `indexed` | address | undefined | -| fee | uint256 | undefined | diff --git a/docs/docs/developer/api/contracts/protocol/AllowlistMinter.md b/docs/docs/developer/api/contracts/protocol/AllowlistMinter.md deleted file mode 100644 index ed412b6b..00000000 --- a/docs/docs/developer/api/contracts/protocol/AllowlistMinter.md +++ /dev/null @@ -1,102 +0,0 @@ -# AllowlistMinter - -_bitbeckers_ - -> Interface for hypercert token interactions - -This interface declares the required functionality for a hypercert tokenThis interface does not specify the underlying token type (e.g. 721 or 1155) - -## Methods - -### getMinted - -```solidity -function getMinted(uint256 claimID) external view returns (uint256 mintedUnits) -``` - -#### Parameters - -| Name | Type | Description | -| ------- | ------- | ----------- | -| claimID | uint256 | undefined | - -#### Returns - -| Name | Type | Description | -| ----------- | ------- | ----------- | -| mintedUnits | uint256 | undefined | - -### hasBeenClaimed - -```solidity -function hasBeenClaimed(uint256, bytes32) external view returns (bool) -``` - -#### Parameters - -| Name | Type | Description | -| ---- | ------- | ----------- | -| \_0 | uint256 | undefined | -| \_1 | bytes32 | undefined | - -#### Returns - -| Name | Type | Description | -| ---- | ---- | ----------- | -| \_0 | bool | undefined | - -### isAllowedToClaim - -```solidity -function isAllowedToClaim(bytes32[] proof, uint256 claimID, bytes32 leaf) external view returns (bool isAllowed) -``` - -#### Parameters - -| Name | Type | Description | -| ------- | --------- | ----------- | -| proof | bytes32[] | undefined | -| claimID | uint256 | undefined | -| leaf | bytes32 | undefined | - -#### Returns - -| Name | Type | Description | -| --------- | ---- | ----------- | -| isAllowed | bool | undefined | - -## Events - -### AllowlistCreated - -```solidity -event AllowlistCreated(uint256 tokenID, bytes32 root) -``` - -#### Parameters - -| Name | Type | Description | -| ------- | ------- | ----------- | -| tokenID | uint256 | undefined | -| root | bytes32 | undefined | - -### LeafClaimed - -```solidity -event LeafClaimed(uint256 tokenID, bytes32 leaf) -``` - -#### Parameters - -| Name | Type | Description | -| ------- | ------- | ----------- | -| tokenID | uint256 | undefined | -| leaf | bytes32 | undefined | - -## Errors - -### DoesNotExist - -```solidity -error DoesNotExist() -``` diff --git a/docs/docs/developer/api/contracts/protocol/HypercertMinter.md b/docs/docs/developer/api/contracts/protocol/HypercertMinter.md deleted file mode 100644 index b2780935..00000000 --- a/docs/docs/developer/api/contracts/protocol/HypercertMinter.md +++ /dev/null @@ -1,913 +0,0 @@ -# HypercertMinter - -_bitbeckers_ - -> Contract for managing hypercert claims and whitelists - -Implementation of the HypercertTokenInterface using { SemiFungible1155 } as underlying token.This contract supports whitelisted minting via { AllowlistMinter }. - -_Wrapper contract to expose and chain functions._ - -## Methods - -### \_\_SemiFungible1155_init - -```solidity -function __SemiFungible1155_init() external nonpayable -``` - -_see { openzeppelin-contracts-upgradeable/contracts/proxy/utils/Initializable.sol }_ - -### balanceOf - -```solidity -function balanceOf(address account, uint256 id) external view returns (uint256) -``` - -_See {IERC1155-balanceOf}. Requirements: - `account` cannot be the zero address._ - -#### Parameters - -| Name | Type | Description | -| ------- | ------- | ----------- | -| account | address | undefined | -| id | uint256 | undefined | - -#### Returns - -| Name | Type | Description | -| ---- | ------- | ----------- | -| \_0 | uint256 | undefined | - -### balanceOfBatch - -```solidity -function balanceOfBatch(address[] accounts, uint256[] ids) external view returns (uint256[]) -``` - -_See {IERC1155-balanceOfBatch}. Requirements: - `accounts` and `ids` must have the same length._ - -#### Parameters - -| Name | Type | Description | -| -------- | --------- | ----------- | -| accounts | address[] | undefined | -| ids | uint256[] | undefined | - -#### Returns - -| Name | Type | Description | -| ---- | --------- | ----------- | -| \_0 | uint256[] | undefined | - -### batchBurnFraction - -```solidity -function batchBurnFraction(address _account, uint256[] _tokenIDs) external nonpayable -``` - -Burn a claimtoken - -_see {IHypercertToken}_ - -#### Parameters - -| Name | Type | Description | -| ---------- | --------- | ----------- | -| \_account | address | undefined | -| \_tokenIDs | uint256[] | undefined | - -### batchMintClaimsFromAllowlists - -```solidity -function batchMintClaimsFromAllowlists(address account, bytes32[][] proofs, uint256[] claimIDs, uint256[] units) external nonpayable -``` - -Mint semi-fungible tokens representing a fraction of the claims in `claimIDs` - -_Calls AllowlistMinter to verify `proofs`.Mints the `amount` of units for the hypercert stored under `claimIDs`_ - -#### Parameters - -| Name | Type | Description | -| -------- | ----------- | ----------- | -| account | address | undefined | -| proofs | bytes32[][] | undefined | -| claimIDs | uint256[] | undefined | -| units | uint256[] | undefined | - -### burn - -```solidity -function burn(address account, uint256 id, uint256) external nonpayable -``` - -Burn a claimtoken; override is needed to update units/values - -_see {ERC1155Burnable}_ - -#### Parameters - -| Name | Type | Description | -| ------- | ------- | ----------- | -| account | address | undefined | -| id | uint256 | undefined | -| \_2 | uint256 | undefined | - -### burnBatch - -```solidity -function burnBatch(address account, uint256[] ids, uint256[]) external nonpayable -``` - -Batch burn claimtokens; override is needed to update units/values - -_see {ERC1155Burnable}_ - -#### Parameters - -| Name | Type | Description | -| ------- | --------- | ----------- | -| account | address | undefined | -| ids | uint256[] | undefined | -| \_2 | uint256[] | undefined | - -### burnFraction - -```solidity -function burnFraction(address _account, uint256 _tokenID) external nonpayable -``` - -Burn a claimtoken - -_see {IHypercertToken}_ - -#### Parameters - -| Name | Type | Description | -| --------- | ------- | ----------- | -| \_account | address | undefined | -| \_tokenID | uint256 | undefined | - -### createAllowlist - -```solidity -function createAllowlist(address account, uint256 units, bytes32 merkleRoot, string _uri, enum IHypercertToken.TransferRestrictions restrictions) external nonpayable -``` - -Register a claim and the whitelist for minting token(s) belonging to that claim - -_Calls SemiFungible1155 to store the claim referenced in `uri` with amount of `units`Calls AllowlistMinter to store the `merkleRoot` as proof to authorize claims_ - -#### Parameters - -| Name | Type | Description | -| ------------ | ----------------------------------------- | ----------- | -| account | address | undefined | -| units | uint256 | undefined | -| merkleRoot | bytes32 | undefined | -| \_uri | string | undefined | -| restrictions | enum IHypercertToken.TransferRestrictions | undefined | - -### getMinted - -```solidity -function getMinted(uint256 claimID) external view returns (uint256 mintedUnits) -``` - -#### Parameters - -| Name | Type | Description | -| ------- | ------- | ----------- | -| claimID | uint256 | undefined | - -#### Returns - -| Name | Type | Description | -| ----------- | ------- | ----------- | -| mintedUnits | uint256 | undefined | - -### hasBeenClaimed - -```solidity -function hasBeenClaimed(uint256, bytes32) external view returns (bool) -``` - -#### Parameters - -| Name | Type | Description | -| ---- | ------- | ----------- | -| \_0 | uint256 | undefined | -| \_1 | bytes32 | undefined | - -#### Returns - -| Name | Type | Description | -| ---- | ---- | ----------- | -| \_0 | bool | undefined | - -### initialize - -```solidity -function initialize() external nonpayable -``` - -_see { openzeppelin-contracts-upgradeable/contracts/proxy/utils/Initializable.sol }_ - -### isAllowedToClaim - -```solidity -function isAllowedToClaim(bytes32[] proof, uint256 claimID, bytes32 leaf) external view returns (bool isAllowed) -``` - -#### Parameters - -| Name | Type | Description | -| ------- | --------- | ----------- | -| proof | bytes32[] | undefined | -| claimID | uint256 | undefined | -| leaf | bytes32 | undefined | - -#### Returns - -| Name | Type | Description | -| --------- | ---- | ----------- | -| isAllowed | bool | undefined | - -### isApprovedForAll - -```solidity -function isApprovedForAll(address account, address operator) external view returns (bool) -``` - -_See {IERC1155-isApprovedForAll}._ - -#### Parameters - -| Name | Type | Description | -| -------- | ------- | ----------- | -| account | address | undefined | -| operator | address | undefined | - -#### Returns - -| Name | Type | Description | -| ---- | ---- | ----------- | -| \_0 | bool | undefined | - -### mergeFractions - -```solidity -function mergeFractions(address _account, uint256[] _fractionIDs) external nonpayable -``` - -Merge the value of tokens belonging to the same claim - -_see {IHypercertToken}_ - -#### Parameters - -| Name | Type | Description | -| ------------- | --------- | ----------- | -| \_account | address | undefined | -| \_fractionIDs | uint256[] | undefined | - -### mintClaim - -```solidity -function mintClaim(address account, uint256 units, string _uri, enum IHypercertToken.TransferRestrictions restrictions) external nonpayable -``` - -Mint a semi-fungible token for the impact claim referenced via `uri` - -_see {IHypercertToken}_ - -#### Parameters - -| Name | Type | Description | -| ------------ | ----------------------------------------- | ----------- | -| account | address | undefined | -| units | uint256 | undefined | -| \_uri | string | undefined | -| restrictions | enum IHypercertToken.TransferRestrictions | undefined | - -### mintClaimFromAllowlist - -```solidity -function mintClaimFromAllowlist(address account, bytes32[] proof, uint256 claimID, uint256 units) external nonpayable -``` - -Mint a semi-fungible token representing a fraction of the claim - -_Calls AllowlistMinter to verify `proof`.Mints the `amount` of units for the hypercert stored under `claimID`_ - -#### Parameters - -| Name | Type | Description | -| ------- | --------- | ----------- | -| account | address | undefined | -| proof | bytes32[] | undefined | -| claimID | uint256 | undefined | -| units | uint256 | undefined | - -### mintClaimWithFractions - -```solidity -function mintClaimWithFractions(address account, uint256 units, uint256[] fractions, string _uri, enum IHypercertToken.TransferRestrictions restrictions) external nonpayable -``` - -Mint semi-fungible tokens for the impact claim referenced via `uri` - -_see {IHypercertToken}_ - -#### Parameters - -| Name | Type | Description | -| ------------ | ----------------------------------------- | ----------- | -| account | address | undefined | -| units | uint256 | undefined | -| fractions | uint256[] | undefined | -| \_uri | string | undefined | -| restrictions | enum IHypercertToken.TransferRestrictions | undefined | - -### name - -```solidity -function name() external view returns (string) -``` - -#### Returns - -| Name | Type | Description | -| ---- | ------ | ----------- | -| \_0 | string | undefined | - -### owner - -```solidity -function owner() external view returns (address) -``` - -_Returns the address of the current owner._ - -#### Returns - -| Name | Type | Description | -| ---- | ------- | ----------- | -| \_0 | address | undefined | - -### ownerOf - -```solidity -function ownerOf(uint256 tokenID) external view returns (address _owner) -``` - -_Returns the owner of a given token ID._ - -#### Parameters - -| Name | Type | Description | -| ------- | ------- | ----------------------------- | -| tokenID | uint256 | The ID of the token to query. | - -#### Returns - -| Name | Type | Description | -| ------- | ------- | -------------------------------------- | -| \_owner | address | The address of the owner of the token. | - -### pause - -```solidity -function pause() external nonpayable -``` - -PAUSABLE - -### paused - -```solidity -function paused() external view returns (bool) -``` - -_Returns true if the contract is paused, and false otherwise._ - -#### Returns - -| Name | Type | Description | -| ---- | ---- | ----------- | -| \_0 | bool | undefined | - -### proxiableUUID - -```solidity -function proxiableUUID() external view returns (bytes32) -``` - -_Implementation of the ERC1822 {proxiableUUID} function. This returns the storage slot used by the implementation. It is used to validate the implementation's compatibility when performing an upgrade. IMPORTANT: A proxy pointing at a proxiable contract should not be considered proxiable itself, because this risks bricking a proxy that upgrades to it, by delegating to itself until out of gas. Thus it is critical that this function revert if invoked through a proxy. This is guaranteed by the `notDelegated` modifier._ - -#### Returns - -| Name | Type | Description | -| ---- | ------- | ----------- | -| \_0 | bytes32 | undefined | - -### readTransferRestriction - -```solidity -function readTransferRestriction(uint256 tokenID) external view returns (string) -``` - -TRANSFER RESTRICTIONS - -#### Parameters - -| Name | Type | Description | -| ------- | ------- | ----------- | -| tokenID | uint256 | undefined | - -#### Returns - -| Name | Type | Description | -| ---- | ------ | ----------- | -| \_0 | string | undefined | - -### renounceOwnership - -```solidity -function renounceOwnership() external nonpayable -``` - -_Leaves the contract without owner. It will not be possible to call `onlyOwner` functions anymore. Can only be called by the current owner. NOTE: Renouncing ownership will leave the contract without an owner, thereby removing any functionality that is only available to the owner._ - -### safeBatchTransferFrom - -```solidity -function safeBatchTransferFrom(address from, address to, uint256[] ids, uint256[] amounts, bytes data) external nonpayable -``` - -_See {IERC1155-safeBatchTransferFrom}._ - -#### Parameters - -| Name | Type | Description | -| ------- | --------- | ----------- | -| from | address | undefined | -| to | address | undefined | -| ids | uint256[] | undefined | -| amounts | uint256[] | undefined | -| data | bytes | undefined | - -### safeTransferFrom - -```solidity -function safeTransferFrom(address from, address to, uint256 id, uint256 amount, bytes data) external nonpayable -``` - -_See {IERC1155-safeTransferFrom}._ - -#### Parameters - -| Name | Type | Description | -| ------ | ------- | ----------- | -| from | address | undefined | -| to | address | undefined | -| id | uint256 | undefined | -| amount | uint256 | undefined | -| data | bytes | undefined | - -### setApprovalForAll - -```solidity -function setApprovalForAll(address operator, bool approved) external nonpayable -``` - -_See {IERC1155-setApprovalForAll}._ - -#### Parameters - -| Name | Type | Description | -| -------- | ------- | ----------- | -| operator | address | undefined | -| approved | bool | undefined | - -### splitFraction - -```solidity -function splitFraction(address _account, uint256 _tokenID, uint256[] _newFractions) external nonpayable -``` - -Split a claimtokens value into parts with summed value equal to the original - -_see {IHypercertToken}_ - -#### Parameters - -| Name | Type | Description | -| -------------- | --------- | ----------- | -| \_account | address | undefined | -| \_tokenID | uint256 | undefined | -| \_newFractions | uint256[] | undefined | - -### supportsInterface - -```solidity -function supportsInterface(bytes4 interfaceId) external view returns (bool) -``` - -_See {IERC165-supportsInterface}._ - -#### Parameters - -| Name | Type | Description | -| ----------- | ------ | ----------- | -| interfaceId | bytes4 | undefined | - -#### Returns - -| Name | Type | Description | -| ---- | ---- | ----------- | -| \_0 | bool | undefined | - -### transferOwnership - -```solidity -function transferOwnership(address newOwner) external nonpayable -``` - -_Transfers ownership of the contract to a new account (`newOwner`). Can only be called by the current owner._ - -#### Parameters - -| Name | Type | Description | -| -------- | ------- | ----------- | -| newOwner | address | undefined | - -### unitsOf - -```solidity -function unitsOf(address account, uint256 tokenID) external view returns (uint256 units) -``` - -_see {IHypercertToken}_ - -#### Parameters - -| Name | Type | Description | -| ------- | ------- | ----------- | -| account | address | undefined | -| tokenID | uint256 | undefined | - -#### Returns - -| Name | Type | Description | -| ----- | ------- | ----------- | -| units | uint256 | undefined | - -### unitsOf - -```solidity -function unitsOf(uint256 tokenID) external view returns (uint256 units) -``` - -_see {IHypercertToken}_ - -#### Parameters - -| Name | Type | Description | -| ------- | ------- | ----------- | -| tokenID | uint256 | undefined | - -#### Returns - -| Name | Type | Description | -| ----- | ------- | ----------- | -| units | uint256 | undefined | - -### unpause - -```solidity -function unpause() external nonpayable -``` - -### upgradeTo - -```solidity -function upgradeTo(address newImplementation) external nonpayable -``` - -_Upgrade the implementation of the proxy to `newImplementation`. Calls {\_authorizeUpgrade}. Emits an {Upgraded} event._ - -#### Parameters - -| Name | Type | Description | -| ----------------- | ------- | ----------- | -| newImplementation | address | undefined | - -### upgradeToAndCall - -```solidity -function upgradeToAndCall(address newImplementation, bytes data) external payable -``` - -_Upgrade the implementation of the proxy to `newImplementation`, and subsequently execute the function call encoded in `data`. Calls {\_authorizeUpgrade}. Emits an {Upgraded} event._ - -#### Parameters - -| Name | Type | Description | -| ----------------- | ------- | ----------- | -| newImplementation | address | undefined | -| data | bytes | undefined | - -### uri - -```solidity -function uri(uint256 tokenID) external view returns (string _uri) -``` - -_see { IHypercertMetadata}_ - -#### Parameters - -| Name | Type | Description | -| ------- | ------- | ----------- | -| tokenID | uint256 | undefined | - -#### Returns - -| Name | Type | Description | -| ----- | ------ | ----------- | -| \_uri | string | undefined | - -## Events - -### AdminChanged - -```solidity -event AdminChanged(address previousAdmin, address newAdmin) -``` - -#### Parameters - -| Name | Type | Description | -| ------------- | ------- | ----------- | -| previousAdmin | address | undefined | -| newAdmin | address | undefined | - -### AllowlistCreated - -```solidity -event AllowlistCreated(uint256 tokenID, bytes32 root) -``` - -#### Parameters - -| Name | Type | Description | -| ------- | ------- | ----------- | -| tokenID | uint256 | undefined | -| root | bytes32 | undefined | - -### ApprovalForAll - -```solidity -event ApprovalForAll(address indexed account, address indexed operator, bool approved) -``` - -#### Parameters - -| Name | Type | Description | -| ------------------ | ------- | ----------- | -| account `indexed` | address | undefined | -| operator `indexed` | address | undefined | -| approved | bool | undefined | - -### BatchValueTransfer - -```solidity -event BatchValueTransfer(uint256[] claimIDs, uint256[] fromTokenIDs, uint256[] toTokenIDs, uint256[] values) -``` - -#### Parameters - -| Name | Type | Description | -| ------------ | --------- | ----------- | -| claimIDs | uint256[] | undefined | -| fromTokenIDs | uint256[] | undefined | -| toTokenIDs | uint256[] | undefined | -| values | uint256[] | undefined | - -### BeaconUpgraded - -```solidity -event BeaconUpgraded(address indexed beacon) -``` - -#### Parameters - -| Name | Type | Description | -| ---------------- | ------- | ----------- | -| beacon `indexed` | address | undefined | - -### ClaimStored - -```solidity -event ClaimStored(uint256 indexed claimID, string uri, uint256 totalUnits) -``` - -#### Parameters - -| Name | Type | Description | -| ----------------- | ------- | ----------- | -| claimID `indexed` | uint256 | undefined | -| uri | string | undefined | -| totalUnits | uint256 | undefined | - -### Initialized - -```solidity -event Initialized(uint8 version) -``` - -#### Parameters - -| Name | Type | Description | -| ------- | ----- | ----------- | -| version | uint8 | undefined | - -### LeafClaimed - -```solidity -event LeafClaimed(uint256 tokenID, bytes32 leaf) -``` - -#### Parameters - -| Name | Type | Description | -| ------- | ------- | ----------- | -| tokenID | uint256 | undefined | -| leaf | bytes32 | undefined | - -### OwnershipTransferred - -```solidity -event OwnershipTransferred(address indexed previousOwner, address indexed newOwner) -``` - -#### Parameters - -| Name | Type | Description | -| ----------------------- | ------- | ----------- | -| previousOwner `indexed` | address | undefined | -| newOwner `indexed` | address | undefined | - -### Paused - -```solidity -event Paused(address account) -``` - -#### Parameters - -| Name | Type | Description | -| ------- | ------- | ----------- | -| account | address | undefined | - -### TransferBatch - -```solidity -event TransferBatch(address indexed operator, address indexed from, address indexed to, uint256[] ids, uint256[] values) -``` - -#### Parameters - -| Name | Type | Description | -| ------------------ | --------- | ----------- | -| operator `indexed` | address | undefined | -| from `indexed` | address | undefined | -| to `indexed` | address | undefined | -| ids | uint256[] | undefined | -| values | uint256[] | undefined | - -### TransferSingle - -```solidity -event TransferSingle(address indexed operator, address indexed from, address indexed to, uint256 id, uint256 value) -``` - -#### Parameters - -| Name | Type | Description | -| ------------------ | ------- | ----------- | -| operator `indexed` | address | undefined | -| from `indexed` | address | undefined | -| to `indexed` | address | undefined | -| id | uint256 | undefined | -| value | uint256 | undefined | - -### URI - -```solidity -event URI(string value, uint256 indexed id) -``` - -#### Parameters - -| Name | Type | Description | -| ------------ | ------- | ----------- | -| value | string | undefined | -| id `indexed` | uint256 | undefined | - -### Unpaused - -```solidity -event Unpaused(address account) -``` - -#### Parameters - -| Name | Type | Description | -| ------- | ------- | ----------- | -| account | address | undefined | - -### Upgraded - -```solidity -event Upgraded(address indexed implementation) -``` - -#### Parameters - -| Name | Type | Description | -| ------------------------ | ------- | ----------- | -| implementation `indexed` | address | undefined | - -### ValueTransfer - -```solidity -event ValueTransfer(uint256 claimID, uint256 fromTokenID, uint256 toTokenID, uint256 value) -``` - -#### Parameters - -| Name | Type | Description | -| ----------- | ------- | ----------- | -| claimID | uint256 | undefined | -| fromTokenID | uint256 | undefined | -| toTokenID | uint256 | undefined | -| value | uint256 | undefined | - -## Errors - -### AlreadyClaimed - -```solidity -error AlreadyClaimed() -``` - -### ArraySize - -```solidity -error ArraySize() -``` - -### DoesNotExist - -```solidity -error DoesNotExist() -``` - -### DuplicateEntry - -```solidity -error DuplicateEntry() -``` - -### Invalid - -```solidity -error Invalid() -``` - -### NotAllowed - -```solidity -error NotAllowed() -``` - -### NotApprovedOrOwner - -```solidity -error NotApprovedOrOwner() -``` - -### TransfersNotAllowed - -```solidity -error TransfersNotAllowed() -``` - -### TypeMismatch - -```solidity -error TypeMismatch() -``` diff --git a/docs/docs/developer/api/contracts/protocol/SemiFungible1155.md b/docs/docs/developer/api/contracts/protocol/SemiFungible1155.md deleted file mode 100644 index a4086e37..00000000 --- a/docs/docs/developer/api/contracts/protocol/SemiFungible1155.md +++ /dev/null @@ -1,457 +0,0 @@ -# SemiFungible1155 - -_bitbeckers_ - -> Contract for minting semi-fungible EIP1155 tokens - -Extends { Upgradeable1155 } token with semi-fungible properties and the concept of `units` - -_Adds split bit strategy as described in [EIP-1155](https://eips.ethereum.org/EIPS/eip-1155#non-fungible-tokens)_ - -## Methods - -### \_\_SemiFungible1155_init - -```solidity -function __SemiFungible1155_init() external nonpayable -``` - -_see { openzeppelin-contracts-upgradeable/contracts/proxy/utils/Initializable.sol }_ - -### balanceOf - -```solidity -function balanceOf(address account, uint256 id) external view returns (uint256) -``` - -_See {IERC1155-balanceOf}. Requirements: - `account` cannot be the zero address._ - -#### Parameters - -| Name | Type | Description | -| ------- | ------- | ----------- | -| account | address | undefined | -| id | uint256 | undefined | - -#### Returns - -| Name | Type | Description | -| ---- | ------- | ----------- | -| \_0 | uint256 | undefined | - -### balanceOfBatch - -```solidity -function balanceOfBatch(address[] accounts, uint256[] ids) external view returns (uint256[]) -``` - -_See {IERC1155-balanceOfBatch}. Requirements: - `accounts` and `ids` must have the same length._ - -#### Parameters - -| Name | Type | Description | -| -------- | --------- | ----------- | -| accounts | address[] | undefined | -| ids | uint256[] | undefined | - -#### Returns - -| Name | Type | Description | -| ---- | --------- | ----------- | -| \_0 | uint256[] | undefined | - -### burn - -```solidity -function burn(address account, uint256 id, uint256 value) external nonpayable -``` - -#### Parameters - -| Name | Type | Description | -| ------- | ------- | ----------- | -| account | address | undefined | -| id | uint256 | undefined | -| value | uint256 | undefined | - -### burnBatch - -```solidity -function burnBatch(address account, uint256[] ids, uint256[] values) external nonpayable -``` - -#### Parameters - -| Name | Type | Description | -| ------- | --------- | ----------- | -| account | address | undefined | -| ids | uint256[] | undefined | -| values | uint256[] | undefined | - -### isApprovedForAll - -```solidity -function isApprovedForAll(address account, address operator) external view returns (bool) -``` - -_See {IERC1155-isApprovedForAll}._ - -#### Parameters - -| Name | Type | Description | -| -------- | ------- | ----------- | -| account | address | undefined | -| operator | address | undefined | - -#### Returns - -| Name | Type | Description | -| ---- | ---- | ----------- | -| \_0 | bool | undefined | - -### owner - -```solidity -function owner() external view returns (address) -``` - -_Returns the address of the current owner._ - -#### Returns - -| Name | Type | Description | -| ---- | ------- | ----------- | -| \_0 | address | undefined | - -### ownerOf - -```solidity -function ownerOf(uint256 tokenID) external view returns (address _owner) -``` - -_Returns the owner of a given token ID._ - -#### Parameters - -| Name | Type | Description | -| ------- | ------- | ----------------------------- | -| tokenID | uint256 | The ID of the token to query. | - -#### Returns - -| Name | Type | Description | -| ------- | ------- | -------------------------------------- | -| \_owner | address | The address of the owner of the token. | - -### proxiableUUID - -```solidity -function proxiableUUID() external view returns (bytes32) -``` - -_Implementation of the ERC1822 {proxiableUUID} function. This returns the storage slot used by the implementation. It is used to validate the implementation's compatibility when performing an upgrade. IMPORTANT: A proxy pointing at a proxiable contract should not be considered proxiable itself, because this risks bricking a proxy that upgrades to it, by delegating to itself until out of gas. Thus it is critical that this function revert if invoked through a proxy. This is guaranteed by the `notDelegated` modifier._ - -#### Returns - -| Name | Type | Description | -| ---- | ------- | ----------- | -| \_0 | bytes32 | undefined | - -### renounceOwnership - -```solidity -function renounceOwnership() external nonpayable -``` - -_Leaves the contract without owner. It will not be possible to call `onlyOwner` functions anymore. Can only be called by the current owner. NOTE: Renouncing ownership will leave the contract without an owner, thereby removing any functionality that is only available to the owner._ - -### safeBatchTransferFrom - -```solidity -function safeBatchTransferFrom(address from, address to, uint256[] ids, uint256[] amounts, bytes data) external nonpayable -``` - -_See {IERC1155-safeBatchTransferFrom}._ - -#### Parameters - -| Name | Type | Description | -| ------- | --------- | ----------- | -| from | address | undefined | -| to | address | undefined | -| ids | uint256[] | undefined | -| amounts | uint256[] | undefined | -| data | bytes | undefined | - -### safeTransferFrom - -```solidity -function safeTransferFrom(address from, address to, uint256 id, uint256 amount, bytes data) external nonpayable -``` - -_See {IERC1155-safeTransferFrom}._ - -#### Parameters - -| Name | Type | Description | -| ------ | ------- | ----------- | -| from | address | undefined | -| to | address | undefined | -| id | uint256 | undefined | -| amount | uint256 | undefined | -| data | bytes | undefined | - -### setApprovalForAll - -```solidity -function setApprovalForAll(address operator, bool approved) external nonpayable -``` - -_See {IERC1155-setApprovalForAll}._ - -#### Parameters - -| Name | Type | Description | -| -------- | ------- | ----------- | -| operator | address | undefined | -| approved | bool | undefined | - -### supportsInterface - -```solidity -function supportsInterface(bytes4 interfaceId) external view returns (bool) -``` - -_See {IERC165-supportsInterface}._ - -#### Parameters - -| Name | Type | Description | -| ----------- | ------ | ----------- | -| interfaceId | bytes4 | undefined | - -#### Returns - -| Name | Type | Description | -| ---- | ---- | ----------- | -| \_0 | bool | undefined | - -### transferOwnership - -```solidity -function transferOwnership(address newOwner) external nonpayable -``` - -_Transfers ownership of the contract to a new account (`newOwner`). Can only be called by the current owner._ - -#### Parameters - -| Name | Type | Description | -| -------- | ------- | ----------- | -| newOwner | address | undefined | - -### upgradeTo - -```solidity -function upgradeTo(address newImplementation) external nonpayable -``` - -_Upgrade the implementation of the proxy to `newImplementation`. Calls {\_authorizeUpgrade}. Emits an {Upgraded} event._ - -#### Parameters - -| Name | Type | Description | -| ----------------- | ------- | ----------- | -| newImplementation | address | undefined | - -### upgradeToAndCall - -```solidity -function upgradeToAndCall(address newImplementation, bytes data) external payable -``` - -_Upgrade the implementation of the proxy to `newImplementation`, and subsequently execute the function call encoded in `data`. Calls {\_authorizeUpgrade}. Emits an {Upgraded} event._ - -#### Parameters - -| Name | Type | Description | -| ----------------- | ------- | ----------- | -| newImplementation | address | undefined | -| data | bytes | undefined | - -### uri - -```solidity -function uri(uint256 tokenID) external view returns (string _uri) -``` - -_Returns the metadata URI for a given token ID.This function retrieves the metadata URI for the specified token ID by calling the `uri` function of the `ERC1155URIStorageUpgradeable` contract.The metadata URI is a string that points to a JSON file containing information about the token, such as its name, symbol, and image.This function always returns the URI for the basetype so that it's managed in one place._ - -#### Parameters - -| Name | Type | Description | -| ------- | ------- | ----------------------------------------------------- | -| tokenID | uint256 | The ID of the token to retrieve the metadata URI for. | - -#### Returns - -| Name | Type | Description | -| ----- | ------ | -------------------------------------------- | -| \_uri | string | The metadata URI for the specified token ID. | - -## Events - -### AdminChanged - -```solidity -event AdminChanged(address previousAdmin, address newAdmin) -``` - -#### Parameters - -| Name | Type | Description | -| ------------- | ------- | ----------- | -| previousAdmin | address | undefined | -| newAdmin | address | undefined | - -### ApprovalForAll - -```solidity -event ApprovalForAll(address indexed account, address indexed operator, bool approved) -``` - -#### Parameters - -| Name | Type | Description | -| ------------------ | ------- | ----------- | -| account `indexed` | address | undefined | -| operator `indexed` | address | undefined | -| approved | bool | undefined | - -### BatchValueTransfer - -```solidity -event BatchValueTransfer(uint256[] claimIDs, uint256[] fromTokenIDs, uint256[] toTokenIDs, uint256[] values) -``` - -_Emitted on transfer of `values` between `fromTokenIDs` to `toTokenIDs` of `claimIDs`_ - -#### Parameters - -| Name | Type | Description | -| ------------ | --------- | ----------- | -| claimIDs | uint256[] | undefined | -| fromTokenIDs | uint256[] | undefined | -| toTokenIDs | uint256[] | undefined | -| values | uint256[] | undefined | - -### BeaconUpgraded - -```solidity -event BeaconUpgraded(address indexed beacon) -``` - -#### Parameters - -| Name | Type | Description | -| ---------------- | ------- | ----------- | -| beacon `indexed` | address | undefined | - -### Initialized - -```solidity -event Initialized(uint8 version) -``` - -#### Parameters - -| Name | Type | Description | -| ------- | ----- | ----------- | -| version | uint8 | undefined | - -### OwnershipTransferred - -```solidity -event OwnershipTransferred(address indexed previousOwner, address indexed newOwner) -``` - -#### Parameters - -| Name | Type | Description | -| ----------------------- | ------- | ----------- | -| previousOwner `indexed` | address | undefined | -| newOwner `indexed` | address | undefined | - -### TransferBatch - -```solidity -event TransferBatch(address indexed operator, address indexed from, address indexed to, uint256[] ids, uint256[] values) -``` - -#### Parameters - -| Name | Type | Description | -| ------------------ | --------- | ----------- | -| operator `indexed` | address | undefined | -| from `indexed` | address | undefined | -| to `indexed` | address | undefined | -| ids | uint256[] | undefined | -| values | uint256[] | undefined | - -### TransferSingle - -```solidity -event TransferSingle(address indexed operator, address indexed from, address indexed to, uint256 id, uint256 value) -``` - -#### Parameters - -| Name | Type | Description | -| ------------------ | ------- | ----------- | -| operator `indexed` | address | undefined | -| from `indexed` | address | undefined | -| to `indexed` | address | undefined | -| id | uint256 | undefined | -| value | uint256 | undefined | - -### URI - -```solidity -event URI(string value, uint256 indexed id) -``` - -#### Parameters - -| Name | Type | Description | -| ------------ | ------- | ----------- | -| value | string | undefined | -| id `indexed` | uint256 | undefined | - -### Upgraded - -```solidity -event Upgraded(address indexed implementation) -``` - -#### Parameters - -| Name | Type | Description | -| ------------------------ | ------- | ----------- | -| implementation `indexed` | address | undefined | - -### ValueTransfer - -```solidity -event ValueTransfer(uint256 claimID, uint256 fromTokenID, uint256 toTokenID, uint256 value) -``` - -_Emitted on transfer of `value` between `fromTokenID` to `toTokenID` of the same `claimID`_ - -#### Parameters - -| Name | Type | Description | -| ----------- | ------- | ----------- | -| claimID | uint256 | undefined | -| fromTokenID | uint256 | undefined | -| toTokenID | uint256 | undefined | -| value | uint256 | undefined | diff --git a/docs/docs/developer/api/contracts/protocol/interfaces/IAllowlist.md b/docs/docs/developer/api/contracts/protocol/interfaces/IAllowlist.md deleted file mode 100644 index 72455b43..00000000 --- a/docs/docs/developer/api/contracts/protocol/interfaces/IAllowlist.md +++ /dev/null @@ -1,29 +0,0 @@ -# IAllowlist - -_bitbeckers_ - -> Interface for allowlist - -This interface declares the required functionality for a hypercert tokenThis interface does not specify the underlying token type (e.g. 721 or 1155) - -## Methods - -### isAllowedToClaim - -```solidity -function isAllowedToClaim(bytes32[] proof, uint256 tokenID, bytes32 leaf) external view returns (bool isAllowed) -``` - -#### Parameters - -| Name | Type | Description | -| ------- | --------- | ----------- | -| proof | bytes32[] | undefined | -| tokenID | uint256 | undefined | -| leaf | bytes32 | undefined | - -#### Returns - -| Name | Type | Description | -| --------- | ---- | ----------- | -| isAllowed | bool | undefined | diff --git a/docs/docs/developer/api/contracts/protocol/interfaces/IHypercertToken.md b/docs/docs/developer/api/contracts/protocol/interfaces/IHypercertToken.md deleted file mode 100644 index 5bd0e8a9..00000000 --- a/docs/docs/developer/api/contracts/protocol/interfaces/IHypercertToken.md +++ /dev/null @@ -1,192 +0,0 @@ -# IHypercertToken - -_bitbeckers_ - -> Interface for hypercert token interactions - -This interface declares the required functionality for a hypercert tokenThis interface does not specify the underlying token type (e.g. 721 or 1155) - -## Methods - -### batchBurnFraction - -```solidity -function batchBurnFraction(address account, uint256[] tokenIDs) external nonpayable -``` - -Operator must be allowed by `creator` and the tokens must represent the total amount of available units. - -_Function to burn the tokens at `tokenIDs` for `account`_ - -#### Parameters - -| Name | Type | Description | -| -------- | --------- | ----------- | -| account | address | undefined | -| tokenIDs | uint256[] | undefined | - -### burnFraction - -```solidity -function burnFraction(address account, uint256 tokenID) external nonpayable -``` - -Operator must be allowed by `creator` and the token must represent the total amount of available units. - -_Function to burn the token at `tokenID` for `account`_ - -#### Parameters - -| Name | Type | Description | -| ------- | ------- | ----------- | -| account | address | undefined | -| tokenID | uint256 | undefined | - -### mergeFractions - -```solidity -function mergeFractions(address account, uint256[] tokenIDs) external nonpayable -``` - -Tokens that have been merged are burned. - -_Function called to merge tokens within `tokenIDs`._ - -#### Parameters - -| Name | Type | Description | -| -------- | --------- | ----------- | -| account | address | undefined | -| tokenIDs | uint256[] | undefined | - -### mintClaim - -```solidity -function mintClaim(address account, uint256 units, string uri, enum IHypercertToken.TransferRestrictions restrictions) external nonpayable -``` - -_Function called to store a claim referenced via `uri` with a maximum number of fractions `units`._ - -#### Parameters - -| Name | Type | Description | -| ------------ | ----------------------------------------- | ----------- | -| account | address | undefined | -| units | uint256 | undefined | -| uri | string | undefined | -| restrictions | enum IHypercertToken.TransferRestrictions | undefined | - -### mintClaimWithFractions - -```solidity -function mintClaimWithFractions(address account, uint256 units, uint256[] fractions, string uri, enum IHypercertToken.TransferRestrictions restrictions) external nonpayable -``` - -_Function called to store a claim referenced via `uri` with a set of `fractions`.Fractions are internally summed to total units._ - -#### Parameters - -| Name | Type | Description | -| ------------ | ----------------------------------------- | ----------- | -| account | address | undefined | -| units | uint256 | undefined | -| fractions | uint256[] | undefined | -| uri | string | undefined | -| restrictions | enum IHypercertToken.TransferRestrictions | undefined | - -### splitFraction - -```solidity -function splitFraction(address to, uint256 tokenID, uint256[] _values) external nonpayable -``` - -The sum of `values` must equal the current value of `_tokenID`. - -_Function called to split `tokenID` and transfer `to` into units declared in `values`._ - -#### Parameters - -| Name | Type | Description | -| -------- | --------- | ----------- | -| to | address | undefined | -| tokenID | uint256 | undefined | -| \_values | uint256[] | undefined | - -### unitsOf - -```solidity -function unitsOf(address account, uint256 tokenID) external view returns (uint256 units) -``` - -_Returns the `units` held by `account` of a (fractional) token at `claimID`If `tokenID` is a base type, the total amount of `units` held by `account` for the claim is returned.If `tokenID` is a fractional token, the `units` held by `account` the token is returned_ - -#### Parameters - -| Name | Type | Description | -| ------- | ------- | ----------- | -| account | address | undefined | -| tokenID | uint256 | undefined | - -#### Returns - -| Name | Type | Description | -| ----- | ------- | ----------- | -| units | uint256 | undefined | - -### unitsOf - -```solidity -function unitsOf(uint256 tokenID) external view returns (uint256 units) -``` - -_Returns the `units` held by a (fractional) token at `claimID`If `tokenID` is a base type, the total amount of `units` for the claim is returned.If `tokenID` is a fractional token, the `units` held by the token is returned_ - -#### Parameters - -| Name | Type | Description | -| ------- | ------- | ----------- | -| tokenID | uint256 | undefined | - -#### Returns - -| Name | Type | Description | -| ----- | ------- | ----------- | -| units | uint256 | undefined | - -### uri - -```solidity -function uri(uint256 tokenID) external view returns (string metadata) -``` - -_Returns the `uri` for metadata of the claim represented by `tokenID`Metadata must conform to { Hypercert Metadata } spec (based on ERC1155 Metadata)_ - -#### Parameters - -| Name | Type | Description | -| ------- | ------- | ----------- | -| tokenID | uint256 | undefined | - -#### Returns - -| Name | Type | Description | -| -------- | ------ | ----------- | -| metadata | string | undefined | - -## Events - -### ClaimStored - -```solidity -event ClaimStored(uint256 indexed claimID, string uri, uint256 totalUnits) -``` - -_Emitted when token with tokenID `claimID` is stored, with external data reference via `uri`._ - -#### Parameters - -| Name | Type | Description | -| ----------------- | ------- | ----------- | -| claimID `indexed` | uint256 | undefined | -| uri | string | undefined | -| totalUnits | uint256 | undefined | diff --git a/docs/docs/developer/api/contracts/protocol/libs/Errors.md b/docs/docs/developer/api/contracts/protocol/libs/Errors.md deleted file mode 100644 index 93fe0124..00000000 --- a/docs/docs/developer/api/contracts/protocol/libs/Errors.md +++ /dev/null @@ -1,59 +0,0 @@ -# Errors - -_bitbeckers_ - -## Errors - -### AlreadyClaimed - -```solidity -error AlreadyClaimed() -``` - -### ArraySize - -```solidity -error ArraySize() -``` - -### DoesNotExist - -```solidity -error DoesNotExist() -``` - -### DuplicateEntry - -```solidity -error DuplicateEntry() -``` - -### Invalid - -```solidity -error Invalid() -``` - -### NotAllowed - -```solidity -error NotAllowed() -``` - -### NotApprovedOrOwner - -```solidity -error NotApprovedOrOwner() -``` - -### TransfersNotAllowed - -```solidity -error TransfersNotAllowed() -``` - -### TypeMismatch - -```solidity -error TypeMismatch() -``` diff --git a/docs/docs/developer/api/sdk/_category_.yml b/docs/docs/developer/api/sdk/_category_.yml deleted file mode 100644 index 5c4b05b1..00000000 --- a/docs/docs/developer/api/sdk/_category_.yml +++ /dev/null @@ -1,3 +0,0 @@ -label: "API SDK" -position: 0 -collapsed: false \ No newline at end of file diff --git a/docs/docs/developer/api/sdk/classes/ClientError.md b/docs/docs/developer/api/sdk/classes/ClientError.md deleted file mode 100644 index 8958c83b..00000000 --- a/docs/docs/developer/api/sdk/classes/ClientError.md +++ /dev/null @@ -1,198 +0,0 @@ ---- -id: "ClientError" -title: "Class: ClientError" -sidebar_label: "ClientError" -sidebar_position: 0 -custom_edit_url: null ---- - -An error that is caused by a problem with the client. - -## Hierarchy - -- `Error` - - ↳ **`ClientError`** - -## Implements - -- [`CustomError`](../interfaces/CustomError.md) - -## Constructors - -### constructor - -• **new ClientError**(`message`, `payload?`): [`ClientError`](ClientError.md) - -Creates a new instance of the ClientError class. - -#### Parameters - -| Name | Type | Description | -| :--------- | :------- | :------------------------ | -| `message` | `string` | The error message. | -| `payload?` | `Object` | Additional error payload. | - -#### Returns - -[`ClientError`](ClientError.md) - -#### Overrides - -Error.constructor - -#### Defined in - -[sdk/src/types/errors.ts:27](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/errors.ts#L27) - -## Properties - -### cause - -• `Optional` **cause**: `unknown` - -#### Inherited from - -Error.cause - -#### Defined in - -node_modules/.pnpm/typescript@5.3.2/node_modules/typescript/lib/lib.es2022.error.d.ts:24 - ---- - -### message - -• **message**: `string` - -#### Inherited from - -Error.message - -#### Defined in - -node_modules/.pnpm/typescript@5.3.2/node_modules/typescript/lib/lib.es5.d.ts:1076 - ---- - -### name - -• **name**: `string` - -#### Inherited from - -Error.name - -#### Defined in - -node_modules/.pnpm/typescript@5.3.2/node_modules/typescript/lib/lib.es5.d.ts:1075 - ---- - -### payload - -• `Optional` **payload**: `Object` - -Additional error payload. - -#### Index signature - -▪ [key: `string`]: `unknown` - -#### Implementation of - -[CustomError](../interfaces/CustomError.md).[payload](../interfaces/CustomError.md#payload) - -#### Defined in - -[sdk/src/types/errors.ts:20](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/errors.ts#L20) - ---- - -### stack - -• `Optional` **stack**: `string` - -#### Inherited from - -Error.stack - -#### Defined in - -node_modules/.pnpm/typescript@5.3.2/node_modules/typescript/lib/lib.es5.d.ts:1077 - ---- - -### prepareStackTrace - -▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` - -#### Type declaration - -▸ (`err`, `stackTraces`): `any` - -Optional override for formatting stack traces - -##### Parameters - -| Name | Type | -| :------------ | :----------- | -| `err` | `Error` | -| `stackTraces` | `CallSite`[] | - -##### Returns - -`any` - -**`See`** - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - -#### Inherited from - -Error.prepareStackTrace - -#### Defined in - -node_modules/.pnpm/@types+node@18.18.7/node_modules/@types/node/globals.d.ts:11 - ---- - -### stackTraceLimit - -▪ `Static` **stackTraceLimit**: `number` - -#### Inherited from - -Error.stackTraceLimit - -#### Defined in - -node_modules/.pnpm/@types+node@18.18.7/node_modules/@types/node/globals.d.ts:13 - -## Methods - -### captureStackTrace - -▸ **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` - -Create .stack property on a target object - -#### Parameters - -| Name | Type | -| :---------------- | :--------- | -| `targetObject` | `object` | -| `constructorOpt?` | `Function` | - -#### Returns - -`void` - -#### Inherited from - -Error.captureStackTrace - -#### Defined in - -node_modules/.pnpm/@types+node@18.18.7/node_modules/@types/node/globals.d.ts:4 diff --git a/docs/docs/developer/api/sdk/classes/ConfigurationError.md b/docs/docs/developer/api/sdk/classes/ConfigurationError.md deleted file mode 100644 index e29844e2..00000000 --- a/docs/docs/developer/api/sdk/classes/ConfigurationError.md +++ /dev/null @@ -1,196 +0,0 @@ ---- -id: "ConfigurationError" -title: "Class: ConfigurationError" -sidebar_label: "ConfigurationError" -sidebar_position: 0 -custom_edit_url: null ---- - -The configuration was invalid - -## Hierarchy - -- `Error` - - ↳ **`ConfigurationError`** - -## Implements - -- [`CustomError`](../interfaces/CustomError.md) - -## Constructors - -### constructor - -• **new ConfigurationError**(`message`, `payload?`): [`ConfigurationError`](ConfigurationError.md) - -#### Parameters - -| Name | Type | -| :--------- | :------- | -| `message` | `string` | -| `payload?` | `Object` | - -#### Returns - -[`ConfigurationError`](ConfigurationError.md) - -#### Overrides - -Error.constructor - -#### Defined in - -[sdk/src/types/errors.ts:188](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/errors.ts#L188) - -## Properties - -### cause - -• `Optional` **cause**: `unknown` - -#### Inherited from - -Error.cause - -#### Defined in - -node_modules/.pnpm/typescript@5.3.2/node_modules/typescript/lib/lib.es2022.error.d.ts:24 - ---- - -### message - -• **message**: `string` - -#### Inherited from - -Error.message - -#### Defined in - -node_modules/.pnpm/typescript@5.3.2/node_modules/typescript/lib/lib.es5.d.ts:1076 - ---- - -### name - -• **name**: `string` - -#### Inherited from - -Error.name - -#### Defined in - -node_modules/.pnpm/typescript@5.3.2/node_modules/typescript/lib/lib.es5.d.ts:1075 - ---- - -### payload - -• `Optional` **payload**: `Object` - -Additional error payload. - -#### Index signature - -▪ [key: `string`]: `unknown` - -#### Implementation of - -[CustomError](../interfaces/CustomError.md).[payload](../interfaces/CustomError.md#payload) - -#### Defined in - -[sdk/src/types/errors.ts:187](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/errors.ts#L187) - ---- - -### stack - -• `Optional` **stack**: `string` - -#### Inherited from - -Error.stack - -#### Defined in - -node_modules/.pnpm/typescript@5.3.2/node_modules/typescript/lib/lib.es5.d.ts:1077 - ---- - -### prepareStackTrace - -▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` - -#### Type declaration - -▸ (`err`, `stackTraces`): `any` - -Optional override for formatting stack traces - -##### Parameters - -| Name | Type | -| :------------ | :----------- | -| `err` | `Error` | -| `stackTraces` | `CallSite`[] | - -##### Returns - -`any` - -**`See`** - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - -#### Inherited from - -Error.prepareStackTrace - -#### Defined in - -node_modules/.pnpm/@types+node@18.18.7/node_modules/@types/node/globals.d.ts:11 - ---- - -### stackTraceLimit - -▪ `Static` **stackTraceLimit**: `number` - -#### Inherited from - -Error.stackTraceLimit - -#### Defined in - -node_modules/.pnpm/@types+node@18.18.7/node_modules/@types/node/globals.d.ts:13 - -## Methods - -### captureStackTrace - -▸ **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` - -Create .stack property on a target object - -#### Parameters - -| Name | Type | -| :---------------- | :--------- | -| `targetObject` | `object` | -| `constructorOpt?` | `Function` | - -#### Returns - -`void` - -#### Inherited from - -Error.captureStackTrace - -#### Defined in - -node_modules/.pnpm/@types+node@18.18.7/node_modules/@types/node/globals.d.ts:4 diff --git a/docs/docs/developer/api/sdk/classes/ContractError.md b/docs/docs/developer/api/sdk/classes/ContractError.md deleted file mode 100644 index 5a2712c1..00000000 --- a/docs/docs/developer/api/sdk/classes/ContractError.md +++ /dev/null @@ -1,197 +0,0 @@ ---- -id: "ContractError" -title: "Class: ContractError" -sidebar_label: "ContractError" -sidebar_position: 0 -custom_edit_url: null ---- - -An error that is returned by the contract - -## Hierarchy - -- `Error` - - ↳ **`ContractError`** - -## Implements - -- [`CustomError`](../interfaces/CustomError.md) - -## Constructors - -### constructor - -• **new ContractError**(`errorName?`, `payload?`): [`ContractError`](ContractError.md) - -#### Parameters - -| Name | Type | -| :------------- | :------------------------------ | -| `errorName?` | `string` | -| `payload?` | `Object` | -| `payload.data` | \`0x$\{string}\` \| `BaseError` | - -#### Returns - -[`ContractError`](ContractError.md) - -#### Overrides - -Error.constructor - -#### Defined in - -[sdk/src/types/errors.ts:43](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/errors.ts#L43) - -## Properties - -### cause - -• `Optional` **cause**: `unknown` - -#### Inherited from - -Error.cause - -#### Defined in - -node_modules/.pnpm/typescript@5.3.2/node_modules/typescript/lib/lib.es2022.error.d.ts:24 - ---- - -### message - -• **message**: `string` - -#### Inherited from - -Error.message - -#### Defined in - -node_modules/.pnpm/typescript@5.3.2/node_modules/typescript/lib/lib.es5.d.ts:1076 - ---- - -### name - -• **name**: `string` - -#### Inherited from - -Error.name - -#### Defined in - -node_modules/.pnpm/typescript@5.3.2/node_modules/typescript/lib/lib.es5.d.ts:1075 - ---- - -### payload - -• `Optional` **payload**: `Object` - -Additional error payload. - -#### Index signature - -▪ [key: `string`]: `unknown` - -#### Implementation of - -[CustomError](../interfaces/CustomError.md).[payload](../interfaces/CustomError.md#payload) - -#### Defined in - -[sdk/src/types/errors.ts:41](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/errors.ts#L41) - ---- - -### stack - -• `Optional` **stack**: `string` - -#### Inherited from - -Error.stack - -#### Defined in - -node_modules/.pnpm/typescript@5.3.2/node_modules/typescript/lib/lib.es5.d.ts:1077 - ---- - -### prepareStackTrace - -▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` - -#### Type declaration - -▸ (`err`, `stackTraces`): `any` - -Optional override for formatting stack traces - -##### Parameters - -| Name | Type | -| :------------ | :----------- | -| `err` | `Error` | -| `stackTraces` | `CallSite`[] | - -##### Returns - -`any` - -**`See`** - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - -#### Inherited from - -Error.prepareStackTrace - -#### Defined in - -node_modules/.pnpm/@types+node@18.18.7/node_modules/@types/node/globals.d.ts:11 - ---- - -### stackTraceLimit - -▪ `Static` **stackTraceLimit**: `number` - -#### Inherited from - -Error.stackTraceLimit - -#### Defined in - -node_modules/.pnpm/@types+node@18.18.7/node_modules/@types/node/globals.d.ts:13 - -## Methods - -### captureStackTrace - -▸ **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` - -Create .stack property on a target object - -#### Parameters - -| Name | Type | -| :---------------- | :--------- | -| `targetObject` | `object` | -| `constructorOpt?` | `Function` | - -#### Returns - -`void` - -#### Inherited from - -Error.captureStackTrace - -#### Defined in - -node_modules/.pnpm/@types+node@18.18.7/node_modules/@types/node/globals.d.ts:4 diff --git a/docs/docs/developer/api/sdk/classes/FetchError.md b/docs/docs/developer/api/sdk/classes/FetchError.md deleted file mode 100644 index 4a80b56b..00000000 --- a/docs/docs/developer/api/sdk/classes/FetchError.md +++ /dev/null @@ -1,198 +0,0 @@ ---- -id: "FetchError" -title: "Class: FetchError" -sidebar_label: "FetchError" -sidebar_position: 0 -custom_edit_url: null ---- - -Fails fetching a remote resource - -## Hierarchy - -- `Error` - - ↳ **`FetchError`** - -## Implements - -- [`CustomError`](../interfaces/CustomError.md) - -## Constructors - -### constructor - -• **new FetchError**(`message`, `payload?`): [`FetchError`](FetchError.md) - -Creates a new instance of the FetchError class. - -#### Parameters - -| Name | Type | Description | -| :--------- | :------- | :------------------------ | -| `message` | `string` | The error message. | -| `payload?` | `Object` | Additional error payload. | - -#### Returns - -[`FetchError`](FetchError.md) - -#### Overrides - -Error.constructor - -#### Defined in - -[sdk/src/types/errors.ts:65](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/errors.ts#L65) - -## Properties - -### cause - -• `Optional` **cause**: `unknown` - -#### Inherited from - -Error.cause - -#### Defined in - -node_modules/.pnpm/typescript@5.3.2/node_modules/typescript/lib/lib.es2022.error.d.ts:24 - ---- - -### message - -• **message**: `string` - -#### Inherited from - -Error.message - -#### Defined in - -node_modules/.pnpm/typescript@5.3.2/node_modules/typescript/lib/lib.es5.d.ts:1076 - ---- - -### name - -• **name**: `string` - -#### Inherited from - -Error.name - -#### Defined in - -node_modules/.pnpm/typescript@5.3.2/node_modules/typescript/lib/lib.es5.d.ts:1075 - ---- - -### payload - -• `Optional` **payload**: `Object` - -Additional error payload. - -#### Index signature - -▪ [key: `string`]: `unknown` - -#### Implementation of - -[CustomError](../interfaces/CustomError.md).[payload](../interfaces/CustomError.md#payload) - -#### Defined in - -[sdk/src/types/errors.ts:58](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/errors.ts#L58) - ---- - -### stack - -• `Optional` **stack**: `string` - -#### Inherited from - -Error.stack - -#### Defined in - -node_modules/.pnpm/typescript@5.3.2/node_modules/typescript/lib/lib.es5.d.ts:1077 - ---- - -### prepareStackTrace - -▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` - -#### Type declaration - -▸ (`err`, `stackTraces`): `any` - -Optional override for formatting stack traces - -##### Parameters - -| Name | Type | -| :------------ | :----------- | -| `err` | `Error` | -| `stackTraces` | `CallSite`[] | - -##### Returns - -`any` - -**`See`** - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - -#### Inherited from - -Error.prepareStackTrace - -#### Defined in - -node_modules/.pnpm/@types+node@18.18.7/node_modules/@types/node/globals.d.ts:11 - ---- - -### stackTraceLimit - -▪ `Static` **stackTraceLimit**: `number` - -#### Inherited from - -Error.stackTraceLimit - -#### Defined in - -node_modules/.pnpm/@types+node@18.18.7/node_modules/@types/node/globals.d.ts:13 - -## Methods - -### captureStackTrace - -▸ **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` - -Create .stack property on a target object - -#### Parameters - -| Name | Type | -| :---------------- | :--------- | -| `targetObject` | `object` | -| `constructorOpt?` | `Function` | - -#### Returns - -`void` - -#### Inherited from - -Error.captureStackTrace - -#### Defined in - -node_modules/.pnpm/@types+node@18.18.7/node_modules/@types/node/globals.d.ts:4 diff --git a/docs/docs/developer/api/sdk/classes/HypercertClient.md b/docs/docs/developer/api/sdk/classes/HypercertClient.md deleted file mode 100644 index 0e538e5b..00000000 --- a/docs/docs/developer/api/sdk/classes/HypercertClient.md +++ /dev/null @@ -1,886 +0,0 @@ ---- -id: "HypercertClient" -title: "Class: HypercertClient" -sidebar_label: "HypercertClient" -sidebar_position: 0 -custom_edit_url: null ---- - -The `HypercertClient` is a core class in the hypercerts SDK, providing a high-level interface to interact with the hypercerts system. - -It encapsulates the logic for storage, evaluation, indexing, and wallet interactions, abstracting the complexity and providing a simple API for users. -The client is read-only if no walletClient was found. - -**`Example`** - -```ts -const config: Partial = { - chain: { id: 11155111 }, -}; -const client = new HypercertClient(config); -``` - -**`Param`** - -The configuration options for the client. - -## Implements - -- [`HypercertClientInterface`](../interfaces/HypercertClientInterface.md) - -## Constructors - -### constructor - -• **new HypercertClient**(`config`): [`HypercertClient`](HypercertClient.md) - -Creates a new instance of the `HypercertClient` class. - -This constructor takes a `config` parameter that is used to configure the client. The `config` parameter should be a `HypercertClientConfig` object. If the public client cannot be connected, it throws a `ClientError`. - -#### Parameters - -| Name | Type | Description | -| :------- | :------------------------------------------------------------------------- | :---------------------------------------- | -| `config` | `Partial`<[`HypercertClientConfig`](../modules.md#hypercertclientconfig)\> | The configuration options for the client. | - -#### Returns - -[`HypercertClient`](HypercertClient.md) - -**`Throws`** - -Will throw a `ClientError` if the public client cannot be connected. - -#### Defined in - -[sdk/src/client.ts:59](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/client.ts#L59) - -## Properties - -### \_config - -• `Readonly` **\_config**: `Partial`<[`HypercertClientConfig`](../modules.md#hypercertclientconfig)\> - -#### Defined in - -[sdk/src/client.ts:42](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/client.ts#L42) - ---- - -### \_evaluator - -• `Private` `Optional` **\_evaluator**: `HypercertEvaluator` - -#### Defined in - -[sdk/src/client.ts:45](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/client.ts#L45) - ---- - -### \_indexer - -• `Private` **\_indexer**: `HypercertIndexer` - -#### Defined in - -[sdk/src/client.ts:46](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/client.ts#L46) - ---- - -### \_publicClient - -• `Private` **\_publicClient**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `account` | `undefined` | The Account of the Client. | -| `batch?` | \{ `multicall?`: `boolean` \| \{ batchSize?: number \| undefined; wait?: number \| undefined; } } | Flags for batch settings. | -| `batch.multicall?` | `boolean` \| \{ batchSize?: number \| undefined; wait?: number \| undefined; } | Toggle to enable `eth_call` multicall aggregation. | -| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | -| `call` | (`parameters`: `CallParameters`<`undefined` \| `Chain`\>) => `Promise`<`CallReturnType`\> | Executes a new message call immediately without submitting a transaction to the network. - Docs: https://viem.sh/docs/actions/public/call - JSON-RPC Methods: [`eth_call`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_call) **`Example`** `ts import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const data = await client.call({ account: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266', data: '0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2', to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8', }) ` | -| `ccipRead?` | `false` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | -| `chain` | `undefined` \| `Chain` | Chain for the client. | -| `createBlockFilter` | () => `Promise`<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn` ; `type`: `"block"` }\> | Creates a Filter to listen for new block hashes that can be used with [`getFilterChanges`](https://viem.sh/docs/actions/public/getFilterChanges). - Docs: https://viem.sh/docs/actions/public/createBlockFilter - JSON-RPC Methods: [`eth_newBlockFilter`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_newBlockFilter) **`Example`** `ts import { createPublicClient, createBlockFilter, http } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const filter = await createBlockFilter(client) // { id: "0x345a6572337856574a76364e457a4366", type: 'block' } ` | -| `createContractEventFilter` | (`args`: `CreateContractEventFilterParameters`<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`<`CreateContractEventFilterReturnType`<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | Creates a Filter to retrieve event logs that can be used with [`getFilterChanges`](https://viem.sh/docs/actions/public/getFilterChanges) or [`getFilterLogs`](https://viem.sh/docs/actions/public/getFilterLogs). - Docs: https://viem.sh/docs/contract/createContractEventFilter **`Example`** `ts import { createPublicClient, http, parseAbi } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const filter = await client.createContractEventFilter({ abi: parseAbi(['event Transfer(address indexed, address indexed, uint256)']), }) ` | -| `createEventFilter` | (`args?`: `CreateEventFilterParameters`<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`, `_EventName`, `_Args`\>) => `Promise`<\{ [K in keyof Filter<"event", TAbiEvents, \_EventName, \_Args, TStrict, TFromBlock, TToBlock\>]: Filter<"event", TAbiEvents, ... 4 more ..., TToBlock\>[K]; }\> | Creates a [`Filter`](https://viem.sh/docs/glossary/types#filter) to listen for new events that can be used with [`getFilterChanges`](https://viem.sh/docs/actions/public/getFilterChanges). - Docs: https://viem.sh/docs/actions/public/createEventFilter - JSON-RPC Methods: [`eth_newFilter`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_newfilter) **`Example`** `ts import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const filter = await client.createEventFilter({ address: '0xfba3912ca04dd458c843e2ee08967fc04f3579c2', }) ` | -| `createPendingTransactionFilter` | () => `Promise`<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn` ; `type`: `"transaction"` }\> | Creates a Filter to listen for new pending transaction hashes that can be used with [`getFilterChanges`](https://viem.sh/docs/actions/public/getFilterChanges). - Docs: https://viem.sh/docs/actions/public/createPendingTransactionFilter - JSON-RPC Methods: [`eth_newPendingTransactionFilter`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_newpendingtransactionfilter) **`Example`** `ts import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const filter = await client.createPendingTransactionFilter() // { id: "0x345a6572337856574a76364e457a4366", type: 'transaction' } ` | -| `estimateContractGas` | (`args`: `EstimateContractGasParameters`<`abi`, `functionName`, `args`, `TChain`\>) => `Promise`<`bigint`\> | Estimates the gas required to successfully execute a contract write function call. - Docs: https://viem.sh/docs/contract/estimateContractGas **`Remarks`** Internally, uses a [Public Client](https://viem.sh/docs/clients/public) to call the [`estimateGas` action](https://viem.sh/docs/actions/public/estimateGas) with [ABI-encoded `data`](https://viem.sh/docs/contract/encodeFunctionData). **`Example`** `ts import { createPublicClient, http, parseAbi } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const gas = await client.estimateContractGas({ address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2', abi: parseAbi(['function mint() public']), functionName: 'mint', account: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266', }) ` | -| `estimateFeesPerGas` | (`args?`: `EstimateFeesPerGasParameters`<`undefined` \| `Chain`, `TChainOverride`, `TType`\>) => `Promise`<`EstimateFeesPerGasReturnType`\> | Returns an estimate for the fees per gas for a transaction to be included in the next block. - Docs: https://viem.sh/docs/actions/public/estimateFeesPerGas **`Example`** `ts import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const maxPriorityFeePerGas = await client.estimateFeesPerGas() // { maxFeePerGas: ..., maxPriorityFeePerGas: ... } ` | -| `estimateGas` | (`args`: `EstimateGasParameters`<`undefined` \| `Chain`\>) => `Promise`<`bigint`\> | Estimates the gas necessary to complete a transaction without submitting it to the network. - Docs: https://viem.sh/docs/actions/public/estimateGas - JSON-RPC Methods: [`eth_estimateGas`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_estimategas) **`Example`** `ts import { createPublicClient, http, parseEther } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const gasEstimate = await client.estimateGas({ account: '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e', to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8', value: parseEther('1'), }) ` | -| `estimateMaxPriorityFeePerGas` | (`args?`: \{ `chain`: `null` \| `TChainOverride` }) => `Promise`<`bigint`\> | Returns an estimate for the max priority fee per gas (in wei) for a transaction to be included in the next block. - Docs: https://viem.sh/docs/actions/public/estimateMaxPriorityFeePerGas **`Example`** `ts import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const maxPriorityFeePerGas = await client.estimateMaxPriorityFeePerGas() // 10000000n ` | -| `extend` | (`fn`: (`client`: `Client`<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, `PublicActions`<`Transport`, `undefined` \| `Chain`\>\>) => `client`) => `Client`<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, \{ [K in keyof client]: client[K]; } & `PublicActions`<`Transport`, `undefined` \| `Chain`\>\> | - | -| `getBalance` | (`args`: `GetBalanceParameters`) => `Promise`<`bigint`\> | Returns the balance of an address in wei. - Docs: https://viem.sh/docs/actions/public/getBalance - JSON-RPC Methods: [`eth_getBalance`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_getbalance) **`Remarks`** You can convert the balance to ether units with [`formatEther`](https://viem.sh/docs/utilities/formatEther). `ts const balance = await getBalance(client, { address: '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e', blockTag: 'safe' }) const balanceAsEther = formatEther(balance) // "6.942" ` **`Example`** `ts import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const balance = await client.getBalance({ address: '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e', }) // 10000000000000000000000n (wei) ` | -| `getBlobBaseFee` | () => `Promise`<`bigint`\> | Returns the base fee per blob gas in wei. - Docs: https://viem.sh/docs/actions/public/getBlobBaseFee - JSON-RPC Methods: [`eth_blobBaseFee`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_blobBaseFee) **`Example`** `ts import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' import { getBlobBaseFee } from 'viem/public' const client = createPublicClient({ chain: mainnet, transport: http(), }) const blobBaseFee = await client.getBlobBaseFee() ` | -| `getBlock` | (`args?`: `GetBlockParameters`<`TIncludeTransactions`, `TBlockTag`\>) => `Promise`<\{ number: TBlockTag extends "pending" ? null : bigint; nonce: TBlockTag extends "pending" ? null : \`0x$\{string}\`; hash: TBlockTag extends "pending" ? null : \`0x$\{string}\`; ... 22 more ...; transactions: TIncludeTransactions extends true ? (\{ ...; } \| ... 2 more ... \| \{ ...; })[] : \`0x$\{string}\`[]; }\> | Returns information about a block at a block number, hash, or tag. - Docs: https://viem.sh/docs/actions/public/getBlock - Examples: https://stackblitz.com/github/wevm/viem/tree/main/examples/blocks/fetching-blocks - JSON-RPC Methods: - Calls [`eth_getBlockByNumber`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_getblockbynumber) for `blockNumber` & `blockTag`. - Calls [`eth_getBlockByHash`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_getblockbyhash) for `blockHash`. **`Example`** `ts import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const block = await client.getBlock() ` | -| `getBlockNumber` | (`args?`: `GetBlockNumberParameters`) => `Promise`<`bigint`\> | Returns the number of the most recent block seen. - Docs: https://viem.sh/docs/actions/public/getBlockNumber - Examples: https://stackblitz.com/github/wevm/viem/tree/main/examples/blocks/fetching-blocks - JSON-RPC Methods: [`eth_blockNumber`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_blocknumber) **`Example`** `ts import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const blockNumber = await client.getBlockNumber() // 69420n ` | -| `getBlockTransactionCount` | (`args?`: `GetBlockTransactionCountParameters`) => `Promise`<`number`\> | Returns the number of Transactions at a block number, hash, or tag. - Docs: https://viem.sh/docs/actions/public/getBlockTransactionCount - JSON-RPC Methods: - Calls [`eth_getBlockTransactionCountByNumber`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_getblocktransactioncountbynumber) for `blockNumber` & `blockTag`. - Calls [`eth_getBlockTransactionCountByHash`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_getblocktransactioncountbyhash) for `blockHash`. **`Example`** `ts import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const count = await client.getBlockTransactionCount() ` | -| `getBytecode` | (`args`: `GetBytecodeParameters`) => `Promise`<`GetBytecodeReturnType`\> | Retrieves the bytecode at an address. - Docs: https://viem.sh/docs/contract/getBytecode - JSON-RPC Methods: [`eth_getCode`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_getcode) **`Example`** `ts import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const code = await client.getBytecode({ address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2', }) ` | -| `getChainId` | () => `Promise`<`number`\> | Returns the chain ID associated with the current network. - Docs: https://viem.sh/docs/actions/public/getChainId - JSON-RPC Methods: [`eth_chainId`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_chainid) **`Example`** `ts import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const chainId = await client.getChainId() // 1 ` | -| `getContractEvents` | (`args`: `GetContractEventsParameters`<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>) => `Promise`<`GetContractEventsReturnType`<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>\> | Returns a list of event logs emitted by a contract. - Docs: https://viem.sh/docs/actions/public/getContractEvents - JSON-RPC Methods: [`eth_getLogs`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_getlogs) **`Example`** `ts import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' import { wagmiAbi } from './abi' const client = createPublicClient({ chain: mainnet, transport: http(), }) const logs = await client.getContractEvents(client, { address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2', abi: wagmiAbi, eventName: 'Transfer' }) ` | -| `getEnsAddress` | (`args`: \{ blockNumber?: bigint \| undefined; blockTag?: BlockTag \| undefined; coinType?: number \| undefined; gatewayUrls?: string[] \| undefined; name: string; strict?: boolean \| undefined; universalResolverAddress?: \`0x$\{string}\` \| undefined; }) => `Promise`<`GetEnsAddressReturnType`\> | Gets address for ENS name. - Docs: https://viem.sh/docs/ens/actions/getEnsAddress - Examples: https://stackblitz.com/github/wevm/viem/tree/main/examples/ens **`Remarks`** Calls `resolve(bytes, bytes)` on ENS Universal Resolver Contract. Since ENS names prohibit certain forbidden characters (e.g. underscore) and have other validation rules, you likely want to [normalize ENS names](https://docs.ens.domains/contract-api-reference/name-processing#normalising-names) with [UTS-46 normalization](https://unicode.org/reports/tr46) before passing them to `getEnsAddress`. You can use the built-in [`normalize`](https://viem.sh/docs/ens/utilities/normalize) function for this. **`Example`** `ts import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' import { normalize } from 'viem/ens' const client = createPublicClient({ chain: mainnet, transport: http(), }) const ensAddress = await client.getEnsAddress({ name: normalize('wevm.eth'), }) // '0xd2135CfB216b74109775236E36d4b433F1DF507B' ` | -| `getEnsAvatar` | (`args`: \{ name: string; blockNumber?: bigint \| undefined; blockTag?: BlockTag \| undefined; gatewayUrls?: string[] \| undefined; strict?: boolean \| undefined; universalResolverAddress?: \`0x$\{string}\` \| undefined; assetGatewayUrls?: AssetGatewayUrls \| undefined; }) => `Promise`<`GetEnsAvatarReturnType`\> | Gets the avatar of an ENS name. - Docs: https://viem.sh/docs/ens/actions/getEnsAvatar - Examples: https://stackblitz.com/github/wevm/viem/tree/main/examples/ens **`Remarks`** Calls [`getEnsText`](https://viem.sh/docs/ens/actions/getEnsText) with `key` set to `'avatar'`. Since ENS names prohibit certain forbidden characters (e.g. underscore) and have other validation rules, you likely want to [normalize ENS names](https://docs.ens.domains/contract-api-reference/name-processing#normalising-names) with [UTS-46 normalization](https://unicode.org/reports/tr46) before passing them to `getEnsAddress`. You can use the built-in [`normalize`](https://viem.sh/docs/ens/utilities/normalize) function for this. **`Example`** `ts import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' import { normalize } from 'viem/ens' const client = createPublicClient({ chain: mainnet, transport: http(), }) const ensAvatar = await client.getEnsAvatar({ name: normalize('wevm.eth'), }) // 'https://ipfs.io/ipfs/Qma8mnp6xV3J2cRNf3mTth5C8nV11CAnceVinc3y8jSbio' ` | -| `getEnsName` | (`args`: \{ blockNumber?: bigint \| undefined; blockTag?: BlockTag \| undefined; address: \`0x$\{string}\`; gatewayUrls?: string[] \| undefined; strict?: boolean \| undefined; universalResolverAddress?: \`0x$\{string}\` \| undefined; }) => `Promise`<`GetEnsNameReturnType`\> | Gets primary name for specified address. - Docs: https://viem.sh/docs/ens/actions/getEnsName - Examples: https://stackblitz.com/github/wevm/viem/tree/main/examples/ens **`Remarks`** Calls `reverse(bytes)` on ENS Universal Resolver Contract to "reverse resolve" the address to the primary ENS name. **`Example`** `ts import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const ensName = await client.getEnsName({ address: '0xd2135CfB216b74109775236E36d4b433F1DF507B', }) // 'wevm.eth' ` | -| `getEnsResolver` | (`args`: \{ blockNumber?: bigint \| undefined; blockTag?: BlockTag \| undefined; name: string; universalResolverAddress?: \`0x$\{string}\` \| undefined; }) => `Promise`<\`0x$\{string}\`\> | Gets resolver for ENS name. - Docs: https://viem.sh/docs/ens/actions/getEnsResolver - Examples: https://stackblitz.com/github/wevm/viem/tree/main/examples/ens **`Remarks`** Calls `findResolver(bytes)` on ENS Universal Resolver Contract to retrieve the resolver of an ENS name. Since ENS names prohibit certain forbidden characters (e.g. underscore) and have other validation rules, you likely want to [normalize ENS names](https://docs.ens.domains/contract-api-reference/name-processing#normalising-names) with [UTS-46 normalization](https://unicode.org/reports/tr46) before passing them to `getEnsAddress`. You can use the built-in [`normalize`](https://viem.sh/docs/ens/utilities/normalize) function for this. **`Example`** `ts import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' import { normalize } from 'viem/ens' const client = createPublicClient({ chain: mainnet, transport: http(), }) const resolverAddress = await client.getEnsResolver({ name: normalize('wevm.eth'), }) // '0x4976fb03C32e5B8cfe2b6cCB31c09Ba78EBaBa41' ` | -| `getEnsText` | (`args`: \{ blockNumber?: bigint \| undefined; blockTag?: BlockTag \| undefined; name: string; gatewayUrls?: string[] \| undefined; key: string; strict?: boolean \| undefined; universalResolverAddress?: \`0x$\{string}\` \| undefined; }) => `Promise`<`GetEnsTextReturnType`\> | Gets a text record for specified ENS name. - Docs: https://viem.sh/docs/ens/actions/getEnsResolver - Examples: https://stackblitz.com/github/wevm/viem/tree/main/examples/ens **`Remarks`** Calls `resolve(bytes, bytes)` on ENS Universal Resolver Contract. Since ENS names prohibit certain forbidden characters (e.g. underscore) and have other validation rules, you likely want to [normalize ENS names](https://docs.ens.domains/contract-api-reference/name-processing#normalising-names) with [UTS-46 normalization](https://unicode.org/reports/tr46) before passing them to `getEnsAddress`. You can use the built-in [`normalize`](https://viem.sh/docs/ens/utilities/normalize) function for this. **`Example`** `ts import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' import { normalize } from 'viem/ens' const client = createPublicClient({ chain: mainnet, transport: http(), }) const twitterRecord = await client.getEnsText({ name: normalize('wevm.eth'), key: 'com.twitter', }) // 'wagmi_sh' ` | -| `getFeeHistory` | (`args`: `GetFeeHistoryParameters`) => `Promise`<`GetFeeHistoryReturnType`\> | Returns a collection of historical gas information. - Docs: https://viem.sh/docs/actions/public/getFeeHistory - JSON-RPC Methods: [`eth_feeHistory`](https://docs.alchemy.com/reference/eth-feehistory) **`Example`** `ts import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const feeHistory = await client.getFeeHistory({ blockCount: 4, rewardPercentiles: [25, 75], }) ` | -| `getFilterChanges` | (`args`: `GetFilterChangesParameters`<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`<`GetFilterChangesReturnType`<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | Returns a list of logs or hashes based on a [Filter](/docs/glossary/terms#filter) since the last time it was called. - Docs: https://viem.sh/docs/actions/public/getFilterChanges - JSON-RPC Methods: [`eth_getFilterChanges`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_getfilterchanges) **`Remarks`** A Filter can be created from the following actions: - [`createBlockFilter`](https://viem.sh/docs/actions/public/createBlockFilter) - [`createContractEventFilter`](https://viem.sh/docs/contract/createContractEventFilter) - [`createEventFilter`](https://viem.sh/docs/actions/public/createEventFilter) - [`createPendingTransactionFilter`](https://viem.sh/docs/actions/public/createPendingTransactionFilter) Depending on the type of filter, the return value will be different: - If the filter was created with `createContractEventFilter` or `createEventFilter`, it returns a list of logs. - If the filter was created with `createPendingTransactionFilter`, it returns a list of transaction hashes. - If the filter was created with `createBlockFilter`, it returns a list of block hashes. **`Example`** `ts // Blocks import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const filter = await client.createBlockFilter() const hashes = await client.getFilterChanges({ filter }) ` **`Example`** `ts // Contract Events import { createPublicClient, http, parseAbi } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const filter = await client.createContractEventFilter({ address: '0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48', abi: parseAbi(['event Transfer(address indexed, address indexed, uint256)']), eventName: 'Transfer', }) const logs = await client.getFilterChanges({ filter }) ` **`Example`** `ts // Raw Events import { createPublicClient, http, parseAbiItem } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const filter = await client.createEventFilter({ address: '0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48', event: parseAbiItem('event Transfer(address indexed, address indexed, uint256)'), }) const logs = await client.getFilterChanges({ filter }) ` **`Example`** `ts // Transactions import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const filter = await client.createPendingTransactionFilter() const hashes = await client.getFilterChanges({ filter }) ` | -| `getFilterLogs` | (`args`: `GetFilterLogsParameters`<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`<`GetFilterLogsReturnType`<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | Returns a list of event logs since the filter was created. - Docs: https://viem.sh/docs/actions/public/getFilterLogs - JSON-RPC Methods: [`eth_getFilterLogs`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_getfilterlogs) **`Remarks`** `getFilterLogs` is only compatible with **event filters**. **`Example`** `ts import { createPublicClient, http, parseAbiItem } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const filter = await client.createEventFilter({ address: '0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48', event: parseAbiItem('event Transfer(address indexed, address indexed, uint256)'), }) const logs = await client.getFilterLogs({ filter }) ` | -| `getGasPrice` | () => `Promise`<`bigint`\> | Returns the current price of gas (in wei). - Docs: https://viem.sh/docs/actions/public/getGasPrice - JSON-RPC Methods: [`eth_gasPrice`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_gasprice) **`Example`** `ts import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const gasPrice = await client.getGasPrice() ` | -| `getLogs` | (`args?`: `GetLogsParameters`<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`<`GetLogsReturnType`<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | Returns a list of event logs matching the provided parameters. - Docs: https://viem.sh/docs/actions/public/getLogs - Examples: https://stackblitz.com/github/wevm/viem/tree/main/examples/filters-and-logs/event-logs - JSON-RPC Methods: [`eth_getLogs`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_getlogs) **`Example`** `ts import { createPublicClient, http, parseAbiItem } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const logs = await client.getLogs() ` | -| `getProof` | (`args`: `GetProofParameters`) => `Promise`<`GetProofReturnType`\> | Returns the account and storage values of the specified account including the Merkle-proof. - Docs: https://viem.sh/docs/actions/public/getProof - JSON-RPC Methods: - Calls [`eth_getProof`](https://eips.ethereum.org/EIPS/eip-1186) **`Example`** `ts import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const block = await client.getProof({ address: '0x...', storageKeys: ['0x...'], }) ` | -| `getStorageAt` | (`args`: `GetStorageAtParameters`) => `Promise`<`GetStorageAtReturnType`\> | Returns the value from a storage slot at a given address. - Docs: https://viem.sh/docs/contract/getStorageAt - JSON-RPC Methods: [`eth_getStorageAt`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_getstorageat) **`Example`** `ts import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' import { getStorageAt } from 'viem/contract' const client = createPublicClient({ chain: mainnet, transport: http(), }) const code = await client.getStorageAt({ address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2', slot: toHex(0), }) ` | -| `getTransaction` | (`args`: `GetTransactionParameters`<`TBlockTag`\>) => `Promise`<\{ type: "legacy"; to: \`0x$\{string}\` \| null; from: \`0x$\{string}\`; gas: bigint; nonce: number; value: bigint; gasPrice: bigint; maxFeePerBlobGas?: undefined; maxFeePerGas?: undefined; maxPriorityFeePerGas?: undefined; ... 12 more ...; transactionIndex: (TBlockTag extends "pending" ? true : false) extends true ? null :... \| \{ type: "eip2930"; to: \`0x$\{string}\` \| null; from: \`0x$\{string}\`; gas: bigint; nonce: number; value: bigint; gasPrice: bigint; maxFeePerBlobGas?: undefined; maxFeePerGas?: undefined; maxPriorityFeePerGas?: undefined; ... 12 more ...; transactionIndex: (TBlockTag extends "pending" ? true : false) extends true ? null ... \| \{ type: "eip1559"; to: \`0x$\{string}\` \| null; from: \`0x$\{string}\`; gas: bigint; nonce: number; value: bigint; gasPrice?: undefined; maxFeePerBlobGas?: undefined; maxFeePerGas: bigint; maxPriorityFeePerGas: bigint; ... 12 more ...; transactionIndex: (TBlockTag extends "pending" ? true : false) extends true ? null : nu... \| \{ type: "eip4844"; to: \`0x$\{string}\` \| null; from: \`0x$\{string}\`; gas: bigint; nonce: number; value: bigint; gasPrice?: undefined; maxFeePerBlobGas: bigint; maxFeePerGas: bigint; maxPriorityFeePerGas: bigint; ... 12 more ...; transactionIndex: (TBlockTag extends "pending" ? true : false) extends true ? null : number...\> | Returns information about a [Transaction](https://viem.sh/docs/glossary/terms#transaction) given a hash or block identifier. - Docs: https://viem.sh/docs/actions/public/getTransaction - Example: https://stackblitz.com/github/wevm/viem/tree/main/examples/transactions/fetching-transactions - JSON-RPC Methods: [`eth_getTransactionByHash`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_getTransactionByHash) **`Example`** `ts import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const transaction = await client.getTransaction({ hash: '0x4ca7ee652d57678f26e887c149ab0735f41de37bcad58c9f6d3ed5824f15b74d', }) ` | -| `getTransactionConfirmations` | (`args`: `GetTransactionConfirmationsParameters`<`undefined` \| `Chain`\>) => `Promise`<`bigint`\> | Returns the number of blocks passed (confirmations) since the transaction was processed on a block. - Docs: https://viem.sh/docs/actions/public/getTransactionConfirmations - Example: https://stackblitz.com/github/wevm/viem/tree/main/examples/transactions/fetching-transactions - JSON-RPC Methods: [`eth_getTransactionConfirmations`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_getTransactionConfirmations) **`Example`** `ts import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const confirmations = await client.getTransactionConfirmations({ hash: '0x4ca7ee652d57678f26e887c149ab0735f41de37bcad58c9f6d3ed5824f15b74d', }) ` | -| `getTransactionCount` | (`args`: `GetTransactionCountParameters`) => `Promise`<`number`\> | Returns the number of [Transactions](https://viem.sh/docs/glossary/terms#transaction) an Account has broadcast / sent. - Docs: https://viem.sh/docs/actions/public/getTransactionCount - JSON-RPC Methods: [`eth_getTransactionCount`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_gettransactioncount) **`Example`** `ts import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const transactionCount = await client.getTransactionCount({ address: '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e', }) ` | -| `getTransactionReceipt` | (`args`: `GetTransactionReceiptParameters`) => `Promise`<`TransactionReceipt`\> | Returns the [Transaction Receipt](https://viem.sh/docs/glossary/terms#transaction-receipt) given a [Transaction](https://viem.sh/docs/glossary/terms#transaction) hash. - Docs: https://viem.sh/docs/actions/public/getTransactionReceipt - Example: https://stackblitz.com/github/wevm/viem/tree/main/examples/transactions/fetching-transactions - JSON-RPC Methods: [`eth_getTransactionReceipt`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_getTransactionReceipt) **`Example`** `ts import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const transactionReceipt = await client.getTransactionReceipt({ hash: '0x4ca7ee652d57678f26e887c149ab0735f41de37bcad58c9f6d3ed5824f15b74d', }) ` | -| `key` | `string` | A key for the client. | -| `multicall` | (`args`: `MulticallParameters`<`contracts`, `allowFailure`\>) => `Promise`<`MulticallReturnType`<`contracts`, `allowFailure`\>\> | Similar to [`readContract`](https://viem.sh/docs/contract/readContract), but batches up multiple functions on a contract in a single RPC call via the [`multicall3` contract](https://github.com/mds1/multicall). - Docs: https://viem.sh/docs/contract/multicall **`Example`** `ts import { createPublicClient, http, parseAbi } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const abi = parseAbi([ 'function balanceOf(address) view returns (uint256)', 'function totalSupply() view returns (uint256)', ]) const result = await client.multicall({ contracts: [ { address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2', abi, functionName: 'balanceOf', args: ['0xA0Cf798816D4b9b9866b5330EEa46a18382f251e'], }, { address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2', abi, functionName: 'totalSupply', }, ], }) // [{ result: 424122n, status: 'success' }, { result: 1000000n, status: 'success' }] ` | -| `name` | `string` | A name for the client. | -| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | -| `prepareTransactionRequest` | (`args`: `PrepareTransactionRequestParameters`<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`<\{ [K in keyof (UnionRequiredBy, "transactionRequest", TransactionRequest\>, "from"\> & (DeriveChain<...\> extends Chain ? \{ ...; } : \{ ...; }) & (DeriveAccount<...\> extends Account ? \{ ...; } : \{ ...; }), IsNever<...\> extends true ? un...\> | Prepares a transaction request for signing. - Docs: https://viem.sh/docs/actions/wallet/prepareTransactionRequest **`Example`** `ts import { createWalletClient, custom } from 'viem' import { mainnet } from 'viem/chains' const client = createWalletClient({ chain: mainnet, transport: custom(window.ethereum), }) const request = await client.prepareTransactionRequest({ account: '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e', to: '0x0000000000000000000000000000000000000000', value: 1n, }) ` **`Example`** `ts // Account Hoisting import { createWalletClient, http } from 'viem' import { privateKeyToAccount } from 'viem/accounts' import { mainnet } from 'viem/chains' const client = createWalletClient({ account: privateKeyToAccount('0x…'), chain: mainnet, transport: custom(window.ethereum), }) const request = await client.prepareTransactionRequest({ to: '0x0000000000000000000000000000000000000000', value: 1n, }) ` | -| `readContract` | (`args`: `ReadContractParameters`<`abi`, `functionName`, `args`\>) => `Promise`<`ReadContractReturnType`<`abi`, `functionName`, `args`\>\> | Calls a read-only function on a contract, and returns the response. - Docs: https://viem.sh/docs/contract/readContract - Examples: https://stackblitz.com/github/wevm/viem/tree/main/examples/contracts/reading-contracts **`Remarks`** A "read-only" function (constant function) on a Solidity contract is denoted by a `view` or `pure` keyword. They can only read the state of the contract, and cannot make any changes to it. Since read-only methods do not change the state of the contract, they do not require any gas to be executed, and can be called by any user without the need to pay for gas. Internally, uses a [Public Client](https://viem.sh/docs/clients/public) to call the [`call` action](https://viem.sh/docs/actions/public/call) with [ABI-encoded `data`](https://viem.sh/docs/contract/encodeFunctionData). **`Example`** `ts import { createPublicClient, http, parseAbi } from 'viem' import { mainnet } from 'viem/chains' import { readContract } from 'viem/contract' const client = createPublicClient({ chain: mainnet, transport: http(), }) const result = await client.readContract({ address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2', abi: parseAbi(['function balanceOf(address) view returns (uint256)']), functionName: 'balanceOf', args: ['0xA0Cf798816D4b9b9866b5330EEa46a18382f251e'], }) // 424122n ` | -| `request` | `EIP1193RequestFn`<`PublicRpcSchema`\> | Request function wrapped with friendly error handling | -| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`<\`0x$\{string}\`\> | Sends a **signed** transaction to the network - Docs: https://viem.sh/docs/actions/wallet/sendRawTransaction - JSON-RPC Method: [`eth_sendRawTransaction`](https://ethereum.github.io/execution-apis/api-documentation/) **`Example`** `ts import { createWalletClient, custom } from 'viem' import { mainnet } from 'viem/chains' import { sendRawTransaction } from 'viem/wallet' const client = createWalletClient({ chain: mainnet, transport: custom(window.ethereum), }) const hash = await client.sendRawTransaction({ serializedTransaction: '0x02f850018203118080825208808080c080a04012522854168b27e5dc3d5839bab5e6b39e1a0ffd343901ce1622e3d64b48f1a04e00902ae0502c4728cbf12156290df99c3ed7de85b1dbfe20b5c36931733a33' }) ` | -| `simulateContract` | (`args`: `SimulateContractParameters`<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `chainOverride`, `accountOverride`\>) => `Promise`<`SimulateContractReturnType`<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`, `accountOverride`\>\> | Simulates/validates a contract interaction. This is useful for retrieving **return data** and **revert reasons** of contract write functions. - Docs: https://viem.sh/docs/contract/simulateContract - Examples: https://stackblitz.com/github/wevm/viem/tree/main/examples/contracts/writing-to-contracts **`Remarks`** This function does not require gas to execute and _**does not**_ change the state of the blockchain. It is almost identical to [`readContract`](https://viem.sh/docs/contract/readContract), but also supports contract write functions. Internally, uses a [Public Client](https://viem.sh/docs/clients/public) to call the [`call` action](https://viem.sh/docs/actions/public/call) with [ABI-encoded `data`](https://viem.sh/docs/contract/encodeFunctionData). **`Example`** `ts import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const result = await client.simulateContract({ address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2', abi: parseAbi(['function mint(uint32) view returns (uint32)']), functionName: 'mint', args: ['69420'], account: '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e', }) ` | -| `transport` | `TransportConfig`<`string`, `EIP1193RequestFn`\> & `Record`<`string`, `any`\> | The RPC transport | -| `type` | `string` | The type of client. | -| `uid` | `string` | A unique ID for the client. | -| `uninstallFilter` | (`args`: `UninstallFilterParameters`) => `Promise`<`boolean`\> | Destroys a Filter that was created from one of the following Actions: - [`createBlockFilter`](https://viem.sh/docs/actions/public/createBlockFilter) - [`createEventFilter`](https://viem.sh/docs/actions/public/createEventFilter) - [`createPendingTransactionFilter`](https://viem.sh/docs/actions/public/createPendingTransactionFilter) - Docs: https://viem.sh/docs/actions/public/uninstallFilter - JSON-RPC Methods: [`eth_uninstallFilter`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_uninstallFilter) **`Example`** `ts import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' import { createPendingTransactionFilter, uninstallFilter } from 'viem/public' const filter = await client.createPendingTransactionFilter() const uninstalled = await client.uninstallFilter({ filter }) // true ` | -| `verifyMessage` | (`args`: `VerifyMessageParameters`) => `Promise`<`boolean`\> | - | -| `verifyTypedData` | (`args`: `VerifyTypedDataParameters`) => `Promise`<`boolean`\> | - | -| `waitForTransactionReceipt` | (`args`: `WaitForTransactionReceiptParameters`<`undefined` \| `Chain`\>) => `Promise`<`TransactionReceipt`\> | Waits for the [Transaction](https://viem.sh/docs/glossary/terms#transaction) to be included on a [Block](https://viem.sh/docs/glossary/terms#block) (one confirmation), and then returns the [Transaction Receipt](https://viem.sh/docs/glossary/terms#transaction-receipt). If the Transaction reverts, then the action will throw an error. - Docs: https://viem.sh/docs/actions/public/waitForTransactionReceipt - Example: https://stackblitz.com/github/wevm/viem/tree/main/examples/transactions/sending-transactions - JSON-RPC Methods: - Polls [`eth_getTransactionReceipt`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_getTransactionReceipt) on each block until it has been processed. - If a Transaction has been replaced: - Calls [`eth_getBlockByNumber`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_getblockbynumber) and extracts the transactions - Checks if one of the Transactions is a replacement - If so, calls [`eth_getTransactionReceipt`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_getTransactionReceipt). **`Remarks`** The `waitForTransactionReceipt` action additionally supports Replacement detection (e.g. sped up Transactions). Transactions can be replaced when a user modifies their transaction in their wallet (to speed up or cancel). Transactions are replaced when they are sent from the same nonce. There are 3 types of Transaction Replacement reasons: - `repriced`: The gas price has been modified (e.g. different `maxFeePerGas`) - `cancelled`: The Transaction has been cancelled (e.g. `value === 0n`) - `replaced`: The Transaction has been replaced (e.g. different `value` or `data`) **`Example`** `ts import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const transactionReceipt = await client.waitForTransactionReceipt({ hash: '0x4ca7ee652d57678f26e887c149ab0735f41de37bcad58c9f6d3ed5824f15b74d', }) ` | -| `watchBlockNumber` | (`args`: `WatchBlockNumberParameters`) => `WatchBlockNumberReturnType` | Watches and returns incoming block numbers. - Docs: https://viem.sh/docs/actions/public/watchBlockNumber - Examples: https://stackblitz.com/github/wevm/viem/tree/main/examples/blocks/watching-blocks - JSON-RPC Methods: - When `poll: true`, calls [`eth_blockNumber`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_blocknumber) on a polling interval. - When `poll: false` & WebSocket Transport, uses a WebSocket subscription via [`eth_subscribe`](https://docs.alchemy.com/reference/eth-subscribe-polygon) and the `"newHeads"` event. **`Example`** `ts import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const unwatch = await client.watchBlockNumber({ onBlockNumber: (blockNumber) => console.log(blockNumber), }) ` | -| `watchBlocks` | (`args`: `WatchBlocksParameters`<`Transport`, `undefined` \| `Chain`, `TIncludeTransactions`, `TBlockTag`\>) => `WatchBlocksReturnType` | Watches and returns information for incoming blocks. - Docs: https://viem.sh/docs/actions/public/watchBlocks - Examples: https://stackblitz.com/github/wevm/viem/tree/main/examples/blocks/watching-blocks - JSON-RPC Methods: - When `poll: true`, calls [`eth_getBlockByNumber`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_getBlockByNumber) on a polling interval. - When `poll: false` & WebSocket Transport, uses a WebSocket subscription via [`eth_subscribe`](https://docs.alchemy.com/reference/eth-subscribe-polygon) and the `"newHeads"` event. **`Example`** `ts import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const unwatch = await client.watchBlocks({ onBlock: (block) => console.log(block), }) ` | -| `watchContractEvent` | (`args`: `WatchContractEventParameters`<`TAbi`, `TEventName`, `TStrict`, `Transport`\>) => `WatchContractEventReturnType` | Watches and returns emitted contract event logs. - Docs: https://viem.sh/docs/contract/watchContractEvent **`Remarks`** This Action will batch up all the event logs found within the [`pollingInterval`](https://viem.sh/docs/contract/watchContractEvent#pollinginterval-optional), and invoke them via [`onLogs`](https://viem.sh/docs/contract/watchContractEvent#onLogs). `watchContractEvent` will attempt to create an [Event Filter](https://viem.sh/docs/contract/createContractEventFilter) and listen to changes to the Filter per polling interval, however, if the RPC Provider does not support Filters (e.g. `eth_newFilter`), then `watchContractEvent` will fall back to using [`getLogs`](https://viem.sh/docs/actions/public/getLogs) instead. **`Example`** `ts import { createPublicClient, http, parseAbi } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const unwatch = client.watchContractEvent({ address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2', abi: parseAbi(['event Transfer(address indexed from, address indexed to, uint256 value)']), eventName: 'Transfer', args: { from: '0xc961145a54C96E3aE9bAA048c4F4D6b04C13916b' }, onLogs: (logs) => console.log(logs), }) ` | -| `watchEvent` | (`args`: `WatchEventParameters`<`TAbiEvent`, `TAbiEvents`, `TStrict`, `Transport`\>) => `WatchEventReturnType` | Watches and returns emitted [Event Logs](https://viem.sh/docs/glossary/terms#event-log). - Docs: https://viem.sh/docs/actions/public/watchEvent - JSON-RPC Methods: - **RPC Provider supports `eth_newFilter`:** - Calls [`eth_newFilter`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_newfilter) to create a filter (called on initialize). - On a polling interval, it will call [`eth_getFilterChanges`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_getfilterchanges). - **RPC Provider does not support `eth_newFilter`:** - Calls [`eth_getLogs`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_getlogs) for each block between the polling interval. **`Remarks`** This Action will batch up all the Event Logs found within the [`pollingInterval`](https://viem.sh/docs/actions/public/watchEvent#pollinginterval-optional), and invoke them via [`onLogs`](https://viem.sh/docs/actions/public/watchEvent#onLogs). `watchEvent` will attempt to create an [Event Filter](https://viem.sh/docs/actions/public/createEventFilter) and listen to changes to the Filter per polling interval, however, if the RPC Provider does not support Filters (e.g. `eth_newFilter`), then `watchEvent` will fall back to using [`getLogs`](https://viem.sh/docs/actions/public/getLogs) instead. **`Example`** `ts import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const unwatch = client.watchEvent({ onLogs: (logs) => console.log(logs), }) ` | -| `watchPendingTransactions` | (`args`: `WatchPendingTransactionsParameters`<`Transport`\>) => `WatchPendingTransactionsReturnType` | Watches and returns pending transaction hashes. - Docs: https://viem.sh/docs/actions/public/watchPendingTransactions - JSON-RPC Methods: - When `poll: true` - Calls [`eth_newPendingTransactionFilter`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_newpendingtransactionfilter) to initialize the filter. - Calls [`eth_getFilterChanges`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_getFilterChanges) on a polling interval. - When `poll: false` & WebSocket Transport, uses a WebSocket subscription via [`eth_subscribe`](https://docs.alchemy.com/reference/eth-subscribe-polygon) and the `"newPendingTransactions"` event. **`Remarks`** This Action will batch up all the pending transactions found within the [`pollingInterval`](https://viem.sh/docs/actions/public/watchPendingTransactions#pollinginterval-optional), and invoke them via [`onTransactions`](https://viem.sh/docs/actions/public/watchPendingTransactions#ontransactions). **`Example`** `ts import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const unwatch = await client.watchPendingTransactions({ onTransactions: (hashes) => console.log(hashes), }) ` | - -#### Defined in - -[sdk/src/client.ts:47](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/client.ts#L47) - ---- - -### \_storage - -• `Private` **\_storage**: [`HypercertsStorage`](HypercertsStorage.md) - -#### Defined in - -[sdk/src/client.ts:43](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/client.ts#L43) - ---- - -### \_walletClient - -• `Private` `Optional` **\_walletClient**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :-------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `account` | `undefined` \| `Account` | The Account of the Client. | -| `addChain` | (`args`: `AddChainParameters`) => `Promise`<`void`\> | Adds an EVM chain to the wallet. - Docs: https://viem.sh/docs/actions/wallet/addChain - JSON-RPC Methods: [`eth_addEthereumChain`](https://eips.ethereum.org/EIPS/eip-3085) **`Example`** `ts import { createWalletClient, custom } from 'viem' import { optimism } from 'viem/chains' const client = createWalletClient({ transport: custom(window.ethereum), }) await client.addChain({ chain: optimism }) ` | -| `batch?` | \{ `multicall?`: `boolean` \| \{ batchSize?: number \| undefined; wait?: number \| undefined; } } | Flags for batch settings. | -| `batch.multicall?` | `boolean` \| \{ batchSize?: number \| undefined; wait?: number \| undefined; } | Toggle to enable `eth_call` multicall aggregation. | -| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | -| `ccipRead?` | `false` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | -| `chain` | `undefined` \| `Chain` | Chain for the client. | -| `deployContract` | (`args`: `DeployContractParameters`<`abi`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`\>) => `Promise`<\`0x$\{string}\`\> | Deploys a contract to the network, given bytecode and constructor arguments. - Docs: https://viem.sh/docs/contract/deployContract - Examples: https://stackblitz.com/github/wevm/viem/tree/main/examples/contracts/deploying-contracts **`Example`** `ts import { createWalletClient, http } from 'viem' import { privateKeyToAccount } from 'viem/accounts' import { mainnet } from 'viem/chains' const client = createWalletClient({ account: privateKeyToAccount('0x…'), chain: mainnet, transport: http(), }) const hash = await client.deployContract({ abi: [], account: '0x…, bytecode: '0x608060405260405161083e38038061083e833981016040819052610...', }) ` | -| `extend` | (`fn`: (`client`: `Client`<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, `WalletActions`<`undefined` \| `Chain`, `undefined` \| `Account`\>\>) => `client`) => `Client`<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, \{ [K in keyof client]: client[K]; } & `WalletActions`<`undefined` \| `Chain`, `undefined` \| `Account`\>\> | - | -| `getAddresses` | () => `Promise`<`GetAddressesReturnType`\> | Returns a list of account addresses owned by the wallet or client. - Docs: https://viem.sh/docs/actions/wallet/getAddresses - JSON-RPC Methods: [`eth_accounts`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_accounts) **`Example`** `ts import { createWalletClient, custom } from 'viem' import { mainnet } from 'viem/chains' const client = createWalletClient({ chain: mainnet, transport: custom(window.ethereum), }) const accounts = await client.getAddresses() ` | -| `getChainId` | () => `Promise`<`number`\> | Returns the chain ID associated with the current network. - Docs: https://viem.sh/docs/actions/public/getChainId - JSON-RPC Methods: [`eth_chainId`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_chainid) **`Example`** `ts import { createWalletClient, http } from 'viem' import { mainnet } from 'viem/chains' const client = createWalletClient({ chain: mainnet, transport: custom(window.ethereum), }) const chainId = await client.getChainId() // 1 ` | -| `getPermissions` | () => `Promise`<`GetPermissionsReturnType`\> | Gets the wallets current permissions. - Docs: https://viem.sh/docs/actions/wallet/getPermissions - JSON-RPC Methods: [`wallet_getPermissions`](https://eips.ethereum.org/EIPS/eip-2255) **`Example`** `ts import { createWalletClient, custom } from 'viem' import { mainnet } from 'viem/chains' const client = createWalletClient({ chain: mainnet, transport: custom(window.ethereum), }) const permissions = await client.getPermissions() ` | -| `key` | `string` | A key for the client. | -| `name` | `string` | A name for the client. | -| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | -| `prepareTransactionRequest` | (`args`: `PrepareTransactionRequestParameters`<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`<\{ [K in keyof (UnionRequiredBy, "transactionRequest", TransactionRequest\>, "from"\> & (DeriveChain<...\> extends Chain ? \{ ...; } : \{ ...; }) & (DeriveAccount<...\> extends Account ? \{ ...; } : \{ ...; }), IsNever<...\> extends true ? un...\> | Prepares a transaction request for signing. - Docs: https://viem.sh/docs/actions/wallet/prepareTransactionRequest **`Example`** `ts import { createWalletClient, custom } from 'viem' import { mainnet } from 'viem/chains' const client = createWalletClient({ chain: mainnet, transport: custom(window.ethereum), }) const request = await client.prepareTransactionRequest({ account: '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e', to: '0x0000000000000000000000000000000000000000', value: 1n, }) ` **`Example`** `ts // Account Hoisting import { createWalletClient, http } from 'viem' import { privateKeyToAccount } from 'viem/accounts' import { mainnet } from 'viem/chains' const client = createWalletClient({ account: privateKeyToAccount('0x…'), chain: mainnet, transport: custom(window.ethereum), }) const request = await client.prepareTransactionRequest({ to: '0x0000000000000000000000000000000000000000', value: 1n, }) ` | -| `request` | `EIP1193RequestFn`<`WalletRpcSchema`\> | Request function wrapped with friendly error handling | -| `requestAddresses` | () => `Promise`<`RequestAddressesReturnType`\> | Requests a list of accounts managed by a wallet. - Docs: https://viem.sh/docs/actions/wallet/requestAddresses - JSON-RPC Methods: [`eth_requestAccounts`](https://eips.ethereum.org/EIPS/eip-1102) Sends a request to the wallet, asking for permission to access the user's accounts. After the user accepts the request, it will return a list of accounts (addresses). This API can be useful for dapps that need to access the user's accounts in order to execute transactions or interact with smart contracts. **`Example`** `ts import { createWalletClient, custom } from 'viem' import { mainnet } from 'viem/chains' const client = createWalletClient({ chain: mainnet, transport: custom(window.ethereum), }) const accounts = await client.requestAddresses() ` | -| `requestPermissions` | (`args`: \{ [x: string]: Record; eth_accounts: Record; }) => `Promise`<`RequestPermissionsReturnType`\> | Requests permissions for a wallet. - Docs: https://viem.sh/docs/actions/wallet/requestPermissions - JSON-RPC Methods: [`wallet_requestPermissions`](https://eips.ethereum.org/EIPS/eip-2255) **`Example`** `ts import { createWalletClient, custom } from 'viem' import { mainnet } from 'viem/chains' const client = createWalletClient({ chain: mainnet, transport: custom(window.ethereum), }) const permissions = await client.requestPermissions({ eth_accounts: {} }) ` | -| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`<\`0x$\{string}\`\> | Sends a **signed** transaction to the network - Docs: https://viem.sh/docs/actions/wallet/sendRawTransaction - JSON-RPC Method: [`eth_sendRawTransaction`](https://ethereum.github.io/execution-apis/api-documentation/) **`Example`** `ts import { createWalletClient, custom } from 'viem' import { mainnet } from 'viem/chains' import { sendRawTransaction } from 'viem/wallet' const client = createWalletClient({ chain: mainnet, transport: custom(window.ethereum), }) const hash = await client.sendRawTransaction({ serializedTransaction: '0x02f850018203118080825208808080c080a04012522854168b27e5dc3d5839bab5e6b39e1a0ffd343901ce1622e3d64b48f1a04e00902ae0502c4728cbf12156290df99c3ed7de85b1dbfe20b5c36931733a33' }) ` | -| `sendTransaction` | (`args`: `SendTransactionParameters`<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TRequest`\>) => `Promise`<\`0x$\{string}\`\> | Creates, signs, and sends a new transaction to the network. - Docs: https://viem.sh/docs/actions/wallet/sendTransaction - Examples: https://stackblitz.com/github/wevm/viem/tree/main/examples/transactions/sending-transactions - JSON-RPC Methods: - JSON-RPC Accounts: [`eth_sendTransaction`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_sendtransaction) - Local Accounts: [`eth_sendRawTransaction`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_sendrawtransaction) **`Example`** `ts import { createWalletClient, custom } from 'viem' import { mainnet } from 'viem/chains' const client = createWalletClient({ chain: mainnet, transport: custom(window.ethereum), }) const hash = await client.sendTransaction({ account: '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e', to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8', value: 1000000000000000000n, }) ` **`Example`** `ts // Account Hoisting import { createWalletClient, http } from 'viem' import { privateKeyToAccount } from 'viem/accounts' import { mainnet } from 'viem/chains' const client = createWalletClient({ account: privateKeyToAccount('0x…'), chain: mainnet, transport: http(), }) const hash = await client.sendTransaction({ to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8', value: 1000000000000000000n, }) ` | -| `signMessage` | (`args`: `SignMessageParameters`<`undefined` \| `Account`\>) => `Promise`<\`0x$\{string}\`\> | Calculates an Ethereum-specific signature in [EIP-191 format](https://eips.ethereum.org/EIPS/eip-191): `keccak256("\x19Ethereum Signed Message:\n" + len(message) + message))`. - Docs: https://viem.sh/docs/actions/wallet/signMessage - JSON-RPC Methods: - JSON-RPC Accounts: [`personal_sign`](https://docs.metamask.io/guide/signing-data#personal-sign) - Local Accounts: Signs locally. No JSON-RPC request. With the calculated signature, you can: - use [`verifyMessage`](https://viem.sh/docs/utilities/verifyMessage) to verify the signature, - use [`recoverMessageAddress`](https://viem.sh/docs/utilities/recoverMessageAddress) to recover the signing address from a signature. **`Example`** `ts import { createWalletClient, custom } from 'viem' import { mainnet } from 'viem/chains' const client = createWalletClient({ chain: mainnet, transport: custom(window.ethereum), }) const signature = await client.signMessage({ account: '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e', message: 'hello world', }) ` **`Example`** `ts // Account Hoisting import { createWalletClient, http } from 'viem' import { privateKeyToAccount } from 'viem/accounts' import { mainnet } from 'viem/chains' const client = createWalletClient({ account: privateKeyToAccount('0x…'), chain: mainnet, transport: http(), }) const signature = await client.signMessage({ message: 'hello world', }) ` | -| `signTransaction` | (`args`: `SignTransactionParameters`<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`<\`0x02$\{string}\` \| \`0x01$\{string}\` \| \`0x03$\{string}\` \| `TransactionSerializedLegacy`\> | Signs a transaction. - Docs: https://viem.sh/docs/actions/wallet/signTransaction - JSON-RPC Methods: - JSON-RPC Accounts: [`eth_signTransaction`](https://ethereum.github.io/execution-apis/api-documentation/) - Local Accounts: Signs locally. No JSON-RPC request. **`Example`** `ts import { createWalletClient, custom } from 'viem' import { mainnet } from 'viem/chains' const client = createWalletClient({ chain: mainnet, transport: custom(window.ethereum), }) const request = await client.prepareTransactionRequest({ account: '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e', to: '0x0000000000000000000000000000000000000000', value: 1n, }) const signature = await client.signTransaction(request) ` **`Example`** `ts // Account Hoisting import { createWalletClient, http } from 'viem' import { privateKeyToAccount } from 'viem/accounts' import { mainnet } from 'viem/chains' const client = createWalletClient({ account: privateKeyToAccount('0x…'), chain: mainnet, transport: custom(window.ethereum), }) const request = await client.prepareTransactionRequest({ to: '0x0000000000000000000000000000000000000000', value: 1n, }) const signature = await client.signTransaction(request) ` | -| `signTypedData` | (`args`: `SignTypedDataParameters`<`TTypedData`, `TPrimaryType`, `undefined` \| `Account`\>) => `Promise`<\`0x$\{string}\`\> | Signs typed data and calculates an Ethereum-specific signature in [EIP-191 format](https://eips.ethereum.org/EIPS/eip-191): `keccak256("\x19Ethereum Signed Message:\n" + len(message) + message))`. - Docs: https://viem.sh/docs/actions/wallet/signTypedData - JSON-RPC Methods: - JSON-RPC Accounts: [`eth_signTypedData_v4`](https://docs.metamask.io/guide/signing-data#signtypeddata-v4) - Local Accounts: Signs locally. No JSON-RPC request. **`Example`** `ts import { createWalletClient, custom } from 'viem' import { mainnet } from 'viem/chains' const client = createWalletClient({ chain: mainnet, transport: custom(window.ethereum), }) const signature = await client.signTypedData({ account: '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e', domain: { name: 'Ether Mail', version: '1', chainId: 1, verifyingContract: '0xCcCCccccCCCCcCCCCCCcCcCccCcCCCcCcccccccC', }, types: { Person: [ { name: 'name', type: 'string' }, { name: 'wallet', type: 'address' }, ], Mail: [ { name: 'from', type: 'Person' }, { name: 'to', type: 'Person' }, { name: 'contents', type: 'string' }, ], }, primaryType: 'Mail', message: { from: { name: 'Cow', wallet: '0xCD2a3d9F938E13CD947Ec05AbC7FE734Df8DD826', }, to: { name: 'Bob', wallet: '0xbBbBBBBbbBBBbbbBbbBbbbbBBbBbbbbBbBbbBBbB', }, contents: 'Hello, Bob!', }, }) ` **`Example`** `ts // Account Hoisting import { createWalletClient, http } from 'viem' import { privateKeyToAccount } from 'viem/accounts' import { mainnet } from 'viem/chains' const client = createWalletClient({ account: privateKeyToAccount('0x…'), chain: mainnet, transport: http(), }) const signature = await client.signTypedData({ domain: { name: 'Ether Mail', version: '1', chainId: 1, verifyingContract: '0xCcCCccccCCCCcCCCCCCcCcCccCcCCCcCcccccccC', }, types: { Person: [ { name: 'name', type: 'string' }, { name: 'wallet', type: 'address' }, ], Mail: [ { name: 'from', type: 'Person' }, { name: 'to', type: 'Person' }, { name: 'contents', type: 'string' }, ], }, primaryType: 'Mail', message: { from: { name: 'Cow', wallet: '0xCD2a3d9F938E13CD947Ec05AbC7FE734Df8DD826', }, to: { name: 'Bob', wallet: '0xbBbBBBBbbBBBbbbBbbBbbbbBBbBbbbbBbBbbBBbB', }, contents: 'Hello, Bob!', }, }) ` | -| `switchChain` | (`args`: `SwitchChainParameters`) => `Promise`<`void`\> | Switch the target chain in a wallet. - Docs: https://viem.sh/docs/actions/wallet/switchChain - JSON-RPC Methods: [`eth_switchEthereumChain`](https://eips.ethereum.org/EIPS/eip-3326) **`Example`** `ts import { createWalletClient, custom } from 'viem' import { mainnet, optimism } from 'viem/chains' const client = createWalletClient({ chain: mainnet, transport: custom(window.ethereum), }) await client.switchChain({ id: optimism.id }) ` | -| `transport` | `TransportConfig`<`string`, `EIP1193RequestFn`\> & `Record`<`string`, `any`\> | The RPC transport | -| `type` | `string` | The type of client. | -| `uid` | `string` | A unique ID for the client. | -| `watchAsset` | (`args`: `WatchAssetParams`) => `Promise`<`boolean`\> | Adds an EVM chain to the wallet. - Docs: https://viem.sh/docs/actions/wallet/watchAsset - JSON-RPC Methods: [`eth_switchEthereumChain`](https://eips.ethereum.org/EIPS/eip-747) **`Example`** `ts import { createWalletClient, custom } from 'viem' import { mainnet } from 'viem/chains' const client = createWalletClient({ chain: mainnet, transport: custom(window.ethereum), }) const success = await client.watchAsset({ type: 'ERC20', options: { address: '0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2', decimals: 18, symbol: 'WETH', }, }) ` | -| `writeContract` | (`args`: `WriteContractParameters`<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`<\`0x$\{string}\`\> | Executes a write function on a contract. - Docs: https://viem.sh/docs/contract/writeContract - Examples: https://stackblitz.com/github/wevm/viem/tree/main/examples/contracts/writing-to-contracts A "write" function on a Solidity contract modifies the state of the blockchain. These types of functions require gas to be executed, and hence a [Transaction](https://viem.sh/docs/glossary/terms) is needed to be broadcast in order to change the state. Internally, uses a [Wallet Client](https://viem.sh/docs/clients/wallet) to call the [`sendTransaction` action](https://viem.sh/docs/actions/wallet/sendTransaction) with [ABI-encoded `data`](https://viem.sh/docs/contract/encodeFunctionData). **Warning: The `write` internally sends a transaction – it does not validate if the contract write will succeed (the contract may throw an error). It is highly recommended to [simulate the contract write with `contract.simulate`](https://viem.sh/docs/contract/writeContract#usage) before you execute it.** **`Example`** `ts import { createWalletClient, custom, parseAbi } from 'viem' import { mainnet } from 'viem/chains' const client = createWalletClient({ chain: mainnet, transport: custom(window.ethereum), }) const hash = await client.writeContract({ address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2', abi: parseAbi(['function mint(uint32 tokenId) nonpayable']), functionName: 'mint', args: [69420], }) ` **`Example`** `ts // With Validation import { createWalletClient, custom, parseAbi } from 'viem' import { mainnet } from 'viem/chains' const client = createWalletClient({ chain: mainnet, transport: custom(window.ethereum), }) const { request } = await client.simulateContract({ address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2', abi: parseAbi(['function mint(uint32 tokenId) nonpayable']), functionName: 'mint', args: [69420], } const hash = await client.writeContract(request) ` | - -#### Defined in - -[sdk/src/client.ts:48](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/client.ts#L48) - ---- - -### readonly - -• **readonly**: `boolean` - -Whether the client is in read-only mode. - -#### Implementation of - -[HypercertClientInterface](../interfaces/HypercertClientInterface.md).[readonly](../interfaces/HypercertClientInterface.md#readonly) - -#### Defined in - -[sdk/src/client.ts:49](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/client.ts#L49) - -## Accessors - -### config - -• `get` **config**(): `Partial`<[`HypercertClientConfig`](../modules.md#hypercertclientconfig)\> - -Gets the config for the client. - -#### Returns - -`Partial`<[`HypercertClientConfig`](../modules.md#hypercertclientconfig)\> - -The client config. - -#### Defined in - -[sdk/src/client.ts:88](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/client.ts#L88) - ---- - -### indexer - -• `get` **indexer**(): `HypercertIndexer` - -Gets the indexer for the client. - -#### Returns - -`HypercertIndexer` - -The indexer. - -#### Implementation of - -[HypercertClientInterface](../interfaces/HypercertClientInterface.md).[indexer](../interfaces/HypercertClientInterface.md#indexer) - -#### Defined in - -[sdk/src/client.ts:104](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/client.ts#L104) - ---- - -### storage - -• `get` **storage**(): [`HypercertsStorage`](HypercertsStorage.md) - -Gets the storage layer for the client. - -#### Returns - -[`HypercertsStorage`](HypercertsStorage.md) - -The storage layer. - -#### Implementation of - -[HypercertClientInterface](../interfaces/HypercertClientInterface.md).[storage](../interfaces/HypercertClientInterface.md#storage) - -#### Defined in - -[sdk/src/client.ts:96](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/client.ts#L96) - -## Methods - -### batchMintClaimFractionsFromAllowlists - -▸ **batchMintClaimFractionsFromAllowlists**(`claimIds`, `units`, `proofs`, `roots?`, `overrides?`): `Promise`<`undefined` \| \`0x$\{string}\`\> - -Mints multiple claim fractions from allowlists in a batch. - -This method first retrieves the wallet client and account using the `getWallet` method. If the roots are provided, it verifies each proof using the `verifyMerkleProofs` function. If any of the proofs are invalid, it throws an `InvalidOrMissingError`. -It then simulates a contract call to the `batchMintClaimsFromAllowlists` function with the provided parameters and the account, and submits the request using the `submitRequest` method. - -#### Parameters - -| Name | Type | Description | -| :----------- | :------------------------------------------------------- | :------------------------------------------------------------------------ | -| `claimIds` | `bigint`[] | The IDs of the claims to mint. | -| `units` | `bigint`[] | The units of each claim to mint. | -| `proofs` | (\`0x$\{string}\` \| `Uint8Array`)[][] | The proofs for each claim. | -| `roots?` | (\`0x$\{string}\` \| `Uint8Array`)[] | The roots of each proof. If provided, they are used to verify the proofs. | -| `overrides?` | [`SupportedOverrides`](../modules.md#supportedoverrides) | Optional overrides for the contract call. | - -#### Returns - -`Promise`<`undefined` \| \`0x$\{string}\`\> - -A promise that resolves to the transaction hash. - -**`Throws`** - -Will throw an `InvalidOrMissingError` if any of the proofs are invalid. - -#### Implementation of - -[HypercertClientInterface](../interfaces/HypercertClientInterface.md).[batchMintClaimFractionsFromAllowlists](../interfaces/HypercertClientInterface.md#batchmintclaimfractionsfromallowlists) - -#### Defined in - -[sdk/src/client.ts:448](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/client.ts#L448) - ---- - -### batchTransferFractions - -▸ **batchTransferFractions**(`fractionIds`, `to`, `overrides?`): `Promise`<`undefined` \| \`0x$\{string}\`\> - -Transfers multiple claim fractions to a new owner. - -This method first retrieves the wallet client and account using the `getWallet` method. -It then simulates a contract call to the `safeBatchTransferFrom` function with the provided parameters and the account, and submits the request using the `submitRequest` method. - -#### Parameters - -| Name | Type | -| :------------ | :------------------------------------------------------- | -| `fractionIds` | `bigint`[] | -| `to` | \`0x$\{string}\` | -| `overrides?` | [`SupportedOverrides`](../modules.md#supportedoverrides) | - -#### Returns - -`Promise`<`undefined` \| \`0x$\{string}\`\> - -A promise that resolves to the transaction hash. - -#### Implementation of - -[HypercertClientInterface](../interfaces/HypercertClientInterface.md).[batchTransferFractions](../interfaces/HypercertClientInterface.md#batchtransferfractions) - -#### Defined in - -[sdk/src/client.ts:208](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/client.ts#L208) - ---- - -### burnClaimFraction - -▸ **burnClaimFraction**(`claimId`, `overrides?`): `Promise`<`undefined` \| \`0x$\{string}\`\> - -Burns a claim fraction. - -This method first retrieves the wallet client and account using the `getWallet` method. It then retrieves the owner of the claim using the `ownerOf` method of the read contract. -If the claim is not owned by the account, it throws a `ClientError`. -It then simulates a contract call to the `burnFraction` function with the provided parameters and the account, and submits the request using the `submitRequest` method. - -#### Parameters - -| Name | Type | Description | -| :----------- | :------------------------------------------------------- | :---------------------------------------- | -| `claimId` | `bigint` | The ID of the claim to burn. | -| `overrides?` | [`SupportedOverrides`](../modules.md#supportedoverrides) | Optional overrides for the contract call. | - -#### Returns - -`Promise`<`undefined` \| \`0x$\{string}\`\> - -A promise that resolves to the transaction hash. - -**`Throws`** - -Will throw a `ClientError` if the claim is not owned by the account. - -#### Implementation of - -[HypercertClientInterface](../interfaces/HypercertClientInterface.md).[burnClaimFraction](../interfaces/HypercertClientInterface.md#burnclaimfraction) - -#### Defined in - -[sdk/src/client.ts:371](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/client.ts#L371) - ---- - -### createAllowlist - -▸ **createAllowlist**(`allowList`, `metaData`, `totalUnits`, `transferRestriction`, `overrides?`): `Promise`<`undefined` \| \`0x$\{string}\`\> - -Creates an allowlist. - -This method first validates the provided allowlist and metadata using the `validateAllowlist` and `validateMetaData` functions respectively. If either is invalid, it throws a `MalformedDataError`. -It then creates an allowlist from the provided entries and stores it on IPFS using the `storeData` method of the storage client. -After that, it stores the metadata (including the CID of the allowlist) on IPFS using the `storeMetadata` method of the storage client. -Finally, it simulates a contract call to the `createAllowlist` function with the provided parameters and the stored metadata CID, and submits the request using the `submitRequest` method. - -#### Parameters - -| Name | Type | Description | -| :-------------------- | :------------------------------------------------------------- | :---------------------------------------- | -| `allowList` | [`AllowlistEntry`](../modules.md#allowlistentry)[] | The entries for the allowlist. | -| `metaData` | [`HypercertMetadata`](../interfaces/HypercertMetadata.md) | The metadata for the claim. | -| `totalUnits` | `bigint` | The total units for the claim. | -| `transferRestriction` | [`TransferRestrictions`](../modules.md#transferrestrictions-1) | The transfer restrictions for the claim. | -| `overrides?` | [`SupportedOverrides`](../modules.md#supportedoverrides) | Optional overrides for the contract call. | - -#### Returns - -`Promise`<`undefined` \| \`0x$\{string}\`\> - -A promise that resolves to the transaction hash. - -**`Throws`** - -Will throw a `MalformedDataError` if the provided allowlist or metadata is invalid. - -#### Implementation of - -[HypercertClientInterface](../interfaces/HypercertClientInterface.md).[createAllowlist](../interfaces/HypercertClientInterface.md#createallowlist) - -#### Defined in - -[sdk/src/client.ts:241](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/client.ts#L241) - ---- - -### getClaimStoredDataFromTxHash - -▸ **getClaimStoredDataFromTxHash**(`hash`): `Promise`<`ParserReturnType`\> - -#### Parameters - -| Name | Type | -| :----- | :--------------- | -| `hash` | \`0x$\{string}\` | - -#### Returns - -`Promise`<`ParserReturnType`\> - -#### Defined in - -[sdk/src/client.ts:479](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/client.ts#L479) - ---- - -### getCleanedOverrides - -▸ **getCleanedOverrides**(`overrides?`): `Object` - -#### Parameters - -| Name | Type | -| :----------- | :------------------------------------------------------- | -| `overrides?` | [`SupportedOverrides`](../modules.md#supportedoverrides) | - -#### Returns - -`Object` - -#### Defined in - -[sdk/src/client.ts:496](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/client.ts#L496) - ---- - -### getContractConfig - -▸ **getContractConfig**(): `Object` - -#### Returns - -`Object` - -| Name | Type | Description | -| :------------------ | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `abi` | (\{ `anonymous?`: `undefined` = false; `inputs`: `never`[] = []; `name?`: `undefined` = "balanceOf"; `outputs?`: `undefined` ; `stateMutability`: `string` = "nonpayable"; `type`: `string` = "constructor" } \| \{ `anonymous?`: `undefined` = false; `inputs`: `never`[] = []; `name`: `string` = "AlreadyClaimed"; `outputs?`: `undefined` ; `stateMutability?`: `undefined` = "view"; `type`: `string` = "error" } \| \{ `anonymous`: `boolean` = false; `inputs`: \{ `indexed`: `boolean` = false; `internalType`: `string` = "address"; `name`: `string` = "previousAdmin"; `type`: `string` = "address" }[] ; `name`: `string` = "AdminChanged"; `outputs?`: `undefined` ; `stateMutability?`: `undefined` = "view"; `type`: `string` = "event" } \| \{ `anonymous?`: `undefined` = false; `inputs`: \{ `internalType`: `string` = "address"; `name`: `string` = "account"; `type`: `string` = "address" }[] ; `name`: `string` = "balanceOf"; `outputs`: \{ `internalType`: `string` = "uint256"; `name`: `string` = ""; `type`: `string` = "uint256" }[] ; `stateMutability`: `string` = "view"; `type`: `string` = "function" })[] | - | -| `address` | \`0x$\{string}\` | - | -| `createEventFilter` | {} | Creates a Filter to retrieve event logs that can be used with [`getFilterChanges`](https://viem.sh/docs/actions/public/getFilterChanges) or [`getFilterLogs`](https://viem.sh/docs/actions/public/getFilterLogs). **`Example`** `ts import { createPublicClient, getContract, http, parseAbi } from 'viem' import { mainnet } from 'viem/chains' const publicClient = createPublicClient({ chain: mainnet, transport: http(), }) const contract = getContract({ address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2', abi: parseAbi(['event Transfer(address indexed, address indexed, uint256)']), client: publicClient, }) const filter = await contract.createEventFilter.Transfer() ` | -| `estimateGas` | {} | Estimates the gas necessary to complete a transaction without submitting it to the network. **`Example`** `ts import { createPublicClient, getContract, http, parseAbi } from 'viem' import { mainnet } from 'viem/chains' const publicClient = createPublicClient({ chain: mainnet, transport: http(), }) const contract = getContract({ address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2', abi: parseAbi(['function mint() public']), client: publicClient, }) const gas = await contract.estimateGas.mint({ account: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266', }) ` | -| `getEvents` | {} | Creates a Filter to retrieve event logs that can be used with [`getFilterChanges`](https://viem.sh/docs/actions/public/getFilterChanges) or [`getFilterLogs`](https://viem.sh/docs/actions/public/getFilterLogs). **`Example`** `ts import { createPublicClient, getContract, http, parseAbi } from 'viem' import { mainnet } from 'viem/chains' const publicClient = createPublicClient({ chain: mainnet, transport: http(), }) const contract = getContract({ address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2', abi: parseAbi(['event Transfer(address indexed, address indexed, uint256)']), client: publicClient, }) const filter = await contract.createEventFilter.Transfer() ` | -| `read` | {} | Calls a read-only function on a contract, and returns the response. A "read-only" function (constant function) on a Solidity contract is denoted by a `view` or `pure` keyword. They can only read the state of the contract, and cannot make any changes to it. Since read-only methods do not change the state of the contract, they do not require any gas to be executed, and can be called by any user without the need to pay for gas. Internally, `read` uses a [Public Client](https://viem.sh/docs/clients/public) to call the [`call` action](https://viem.sh/docs/actions/public/call) with [ABI-encoded `data`](https://viem.sh/docs/contract/encodeFunctionData). **`Example`** `ts import { createPublicClient, getContract, http, parseAbi } from 'viem' import { mainnet } from 'viem/chains' const publicClient = createPublicClient({ chain: mainnet, transport: http(), }) const contract = getContract({ address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2', abi: parseAbi([ 'function balanceOf(address owner) view returns (uint256)', ]), client: publicClient, }) const result = await contract.read.balanceOf(['0xA0Cf798816D4b9b9866b5330EEa46a18382f251e']) // 424122n ` | -| `simulate` | {} | Simulates/validates a contract interaction. This is useful for retrieving return data and revert reasons of contract write functions. This function does not require gas to execute and does not change the state of the blockchain. It is almost identical to [`readContract`](https://viem.sh/docs/contract/readContract), but also supports contract write functions. Internally, `simulate` uses a [Public Client](https://viem.sh/docs/clients/public) to call the [`call` action](https://viem.sh/docs/actions/public/call) with [ABI-encoded `data`](https://viem.sh/docs/contract/encodeFunctionData). **`Example`** `ts import { createPublicClient, getContract, http, parseAbi } from 'viem' import { mainnet } from 'viem/chains' const publicClient = createPublicClient({ chain: mainnet, transport: http(), }) const contract = getContract({ address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2', abi: parseAbi(['function mint() public']), client: publicClient, }) const result = await contract.simulate.mint({ account: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266', }) ` | -| `watchEvent` | {} | Watches and returns emitted contract event logs. This Action will batch up all the event logs found within the [`pollingInterval`](https://viem.sh/docs/contract/watchContractEvent#pollinginterval-optional), and invoke them via [`onLogs`](https://viem.sh/docs/contract/watchContractEvent#onLogs). `watchEvent` will attempt to create an [Event Filter](https://viem.sh/docs/contract/createContractEventFilter) and listen to changes to the Filter per polling interval, however, if the RPC Provider does not support Filters (e.g. `eth_newFilter`), then `watchEvent` will fall back to using [`getLogs`](https://viem.sh/docs/actions/public/getLogs) instead. **`Example`** `ts import { createPublicClient, getContract, http, parseAbi } from 'viem' import { mainnet } from 'viem/chains' const publicClient = createPublicClient({ chain: mainnet, transport: http(), }) const contract = getContract({ address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2', abi: parseAbi(['event Transfer(address indexed, address indexed, uint256)']), client: publicClient, }) const filter = await contract.createEventFilter.Transfer() const unwatch = contract.watchEvent.Transfer( { from: '0xc961145a54C96E3aE9bAA048c4F4D6b04C13916b' }, { onLogs: (logs) => console.log(logs) }, ) ` | - -#### Defined in - -[sdk/src/client.ts:485](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/client.ts#L485) - ---- - -### getDeployments - -▸ **getDeployments**(`chainId`): `Partial`<[`Deployment`](../modules.md#deployment)\> - -Gets the contract addresses and graph urls for the provided `chainId` - -#### Parameters - -| Name | Type | -| :-------- | :----------------------------------------------------- | -| `chainId` | [`SupportedChainIds`](../modules.md#supportedchainids) | - -#### Returns - -`Partial`<[`Deployment`](../modules.md#deployment)\> - -The addresses, graph name and graph url. - -#### Implementation of - -[HypercertClientInterface](../interfaces/HypercertClientInterface.md).[getDeployments](../interfaces/HypercertClientInterface.md#getdeployments) - -#### Defined in - -[sdk/src/client.ts:112](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/client.ts#L112) - ---- - -### getTransferRestrictions - -▸ **getTransferRestrictions**(`fractionId`): `Promise`<[`TransferRestrictions`](../modules.md#transferrestrictions-1)\> - -Gets the TransferRestrictions for a claim. - -This method first retrieves the read contract using the `getContract` method. It then simulates a contract call to the `readTransferRestriction` function with the provided fraction ID. - -#### Parameters - -| Name | Type | -| :----------- | :------- | -| `fractionId` | `bigint` | - -#### Returns - -`Promise`<[`TransferRestrictions`](../modules.md#transferrestrictions-1)\> - -a Promise that resolves to the applicable transfer restrictions. - -#### Implementation of - -[HypercertClientInterface](../interfaces/HypercertClientInterface.md).[getTransferRestrictions](../interfaces/HypercertClientInterface.md#gettransferrestrictions) - -#### Defined in - -[sdk/src/client.ts:160](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/client.ts#L160) - ---- - -### getWallet - -▸ **getWallet**(): `Object` - -#### Returns - -`Object` - -| Name | Type | -| :--------------------------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `account` | `Account` | -| `walletClient` | \{ `account`: `undefined` \| `Account` ; `addChain`: (`args`: `AddChainParameters`) => `Promise`<`void`\> ; `batch?`: \{ `multicall?`: `boolean` \| \{ batchSize?: number \| undefined; wait?: number \| undefined; } } ; `cacheTime`: `number` ; `ccipRead?`: `false` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`<\`0x$\{string}\`\> } ; `chain`: `undefined` \| `Chain` ; `deployContract`: (`args`: `DeployContractParameters`<`abi`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`\>) => `Promise`<\`0x$\{string}\`\> ; `extend`: (`fn`: (`client`: `Client`<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, `WalletActions`<`undefined` \| `Chain`, `undefined` \| `Account`\>\>) => `client`) => `Client`<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, \{ [K in keyof client]: client[K]; } & `WalletActions`<`undefined` \| `Chain`, `undefined` \| `Account`\>\> ; `getAddresses`: () => `Promise`<`GetAddressesReturnType`\> ; `getChainId`: () => `Promise`<`number`\> ; `getPermissions`: () => `Promise`<`GetPermissionsReturnType`\> ; `key`: `string` ; `name`: `string` ; `pollingInterval`: `number` ; `prepareTransactionRequest`: (`args`: `PrepareTransactionRequestParameters`<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`<\{ [K in keyof (UnionRequiredBy, "transactionRequest", TransactionRequest\>, "from"\> & (DeriveChain<...\> extends Chain ? \{ ...; } : \{ ...; }) & (DeriveAccount<...\> extends Account ? \{ ...; } : \{ ...; }), IsNever<...\> extends true ? un...\> ; `request`: `EIP1193RequestFn`<`WalletRpcSchema`\> ; `requestAddresses`: () => `Promise`<`RequestAddressesReturnType`\> ; `requestPermissions`: (`args`: \{ [x: string]: Record; eth_accounts: Record; }) => `Promise`<`RequestPermissionsReturnType`\> ; `sendRawTransaction`: (`args`: `SendRawTransactionParameters`) => `Promise`<\`0x$\{string}\`\> ; `sendTransaction`: (`args`: `SendTransactionParameters`<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TRequest`\>) => `Promise`<\`0x$\{string}\`\> ; `signMessage`: (`args`: `SignMessageParameters`<`undefined` \| `Account`\>) => `Promise`<\`0x$\{string}\`\> ; `signTransaction`: (`args`: `SignTransactionParameters`<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`<\`0x02$\{string}\` \| \`0x01$\{string}\` \| \`0x03$\{string}\` \| `TransactionSerializedLegacy`\> ; `signTypedData`: (`args`: `SignTypedDataParameters`<`TTypedData`, `TPrimaryType`, `undefined` \| `Account`\>) => `Promise`<\`0x$\{string}\`\> ; `switchChain`: (`args`: `SwitchChainParameters`) => `Promise`<`void`\> ; `transport`: `TransportConfig`<`string`, `EIP1193RequestFn`\> & `Record`<`string`, `any`\> ; `type`: `string` ; `uid`: `string` ; `watchAsset`: (`args`: `WatchAssetParams`) => `Promise`<`boolean`\> ; `writeContract`: (`args`: `WriteContractParameters`<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`<\`0x$\{string}\`\> } | -| `walletClient.account` | `undefined` \| `Account` | -| `walletClient.addChain` | (`args`: `AddChainParameters`) => `Promise`<`void`\> | -| `walletClient.batch?` | \{ `multicall?`: `boolean` \| \{ batchSize?: number \| undefined; wait?: number \| undefined; } } | -| `walletClient.batch.multicall?` | `boolean` \| \{ batchSize?: number \| undefined; wait?: number \| undefined; } | -| `walletClient.cacheTime` | `number` | -| `walletClient.ccipRead?` | `false` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`<\`0x$\{string}\`\> } | -| `walletClient.chain` | `undefined` \| `Chain` | -| `walletClient.deployContract` | (`args`: `DeployContractParameters`<`abi`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`\>) => `Promise`<\`0x$\{string}\`\> | -| `walletClient.extend` | (`fn`: (`client`: `Client`<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, `WalletActions`<`undefined` \| `Chain`, `undefined` \| `Account`\>\>) => `client`) => `Client`<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, \{ [K in keyof client]: client[K]; } & `WalletActions`<`undefined` \| `Chain`, `undefined` \| `Account`\>\> | -| `walletClient.getAddresses` | () => `Promise`<`GetAddressesReturnType`\> | -| `walletClient.getChainId` | () => `Promise`<`number`\> | -| `walletClient.getPermissions` | () => `Promise`<`GetPermissionsReturnType`\> | -| `walletClient.key` | `string` | -| `walletClient.name` | `string` | -| `walletClient.pollingInterval` | `number` | -| `walletClient.prepareTransactionRequest` | (`args`: `PrepareTransactionRequestParameters`<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`<\{ [K in keyof (UnionRequiredBy, "transactionRequest", TransactionRequest\>, "from"\> & (DeriveChain<...\> extends Chain ? \{ ...; } : \{ ...; }) & (DeriveAccount<...\> extends Account ? \{ ...; } : \{ ...; }), IsNever<...\> extends true ? un...\> | -| `walletClient.request` | `EIP1193RequestFn`<`WalletRpcSchema`\> | -| `walletClient.requestAddresses` | () => `Promise`<`RequestAddressesReturnType`\> | -| `walletClient.requestPermissions` | (`args`: \{ [x: string]: Record; eth_accounts: Record; }) => `Promise`<`RequestPermissionsReturnType`\> | -| `walletClient.sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`<\`0x$\{string}\`\> | -| `walletClient.sendTransaction` | (`args`: `SendTransactionParameters`<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TRequest`\>) => `Promise`<\`0x$\{string}\`\> | -| `walletClient.signMessage` | (`args`: `SignMessageParameters`<`undefined` \| `Account`\>) => `Promise`<\`0x$\{string}\`\> | -| `walletClient.signTransaction` | (`args`: `SignTransactionParameters`<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`<\`0x02$\{string}\` \| \`0x01$\{string}\` \| \`0x03$\{string}\` \| `TransactionSerializedLegacy`\> | -| `walletClient.signTypedData` | (`args`: `SignTypedDataParameters`<`TTypedData`, `TPrimaryType`, `undefined` \| `Account`\>) => `Promise`<\`0x$\{string}\`\> | -| `walletClient.switchChain` | (`args`: `SwitchChainParameters`) => `Promise`<`void`\> | -| `walletClient.transport` | `TransportConfig`<`string`, `EIP1193RequestFn`\> & `Record`<`string`, `any`\> | -| `walletClient.type` | `string` | -| `walletClient.uid` | `string` | -| `walletClient.watchAsset` | (`args`: `WatchAssetParams`) => `Promise`<`boolean`\> | -| `walletClient.writeContract` | (`args`: `WriteContractParameters`<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`<\`0x$\{string}\`\> | - -#### Defined in - -[sdk/src/client.ts:506](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/client.ts#L506) - ---- - -### isClaimOrFractionOnConnectedChain - -▸ **isClaimOrFractionOnConnectedChain**(`claimOrFractionId`): `boolean` - -Check if a claim or fraction is on the chain that the Hypercertclient -is currently connected to - -#### Parameters - -| Name | Type | Description | -| :------------------ | :------- | :---------------------------------------- | -| `claimOrFractionId` | `string` | The ID of the claim or fraction to check. | - -#### Returns - -`boolean` - -#### Implementation of - -[HypercertClientInterface](../interfaces/HypercertClientInterface.md).[isClaimOrFractionOnConnectedChain](../interfaces/HypercertClientInterface.md#isclaimorfractiononconnectedchain) - -#### Defined in - -[sdk/src/client.ts:79](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/client.ts#L79) - ---- - -### mergeFractionUnits - -▸ **mergeFractionUnits**(`fractionIds`, `overrides?`): `Promise`<`undefined` \| \`0x$\{string}\`\> - -Merges multiple fractions into a single fraction. - -This method first retrieves the wallet client and account using the `getWallet` method. It then retrieves the owner of each fraction using the `ownerOf` method of the read contract. -If any of the fractions are not owned by the account, it throws a `ClientError`. -It then simulates a contract call to the `mergeFractions` function with the provided parameters and the account, and submits the request using the `submitRequest` method. - -#### Parameters - -| Name | Type | Description | -| :------------ | :------------------------------------------------------- | :---------------------------------------- | -| `fractionIds` | `bigint`[] | The IDs of the fractions to merge. | -| `overrides?` | [`SupportedOverrides`](../modules.md#supportedoverrides) | Optional overrides for the contract call. | - -#### Returns - -`Promise`<`undefined` \| \`0x$\{string}\`\> - -A promise that resolves to the transaction hash. - -**`Throws`** - -Will throw a `ClientError` if any of the fractions are not owned by the account. - -#### Implementation of - -[HypercertClientInterface](../interfaces/HypercertClientInterface.md).[mergeFractionUnits](../interfaces/HypercertClientInterface.md#mergefractionunits) - -#### Defined in - -[sdk/src/client.ts:330](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/client.ts#L330) - ---- - -### mintClaim - -▸ **mintClaim**(`metaData`, `totalUnits`, `transferRestriction`, `overrides?`): `Promise`<`undefined` \| \`0x$\{string}\`\> - -Mints a new claim. - -This method first validates the provided metadata using the `validateMetaData` function. If the metadata is invalid, it throws a `MalformedDataError`. -It then stores the metadata on IPFS using the `storeMetadata` method of the storage client. -After that, it simulates a contract call to the `mintClaim` function with the provided parameters and the stored metadata CID to validate the transaction. -Finally, it submits the request using the `submitRequest` method. - -#### Parameters - -| Name | Type | Description | -| :-------------------- | :------------------------------------------------------------- | :---------------------------------------- | -| `metaData` | [`HypercertMetadata`](../interfaces/HypercertMetadata.md) | The metadata for the claim. | -| `totalUnits` | `bigint` | The total units for the claim. | -| `transferRestriction` | [`TransferRestrictions`](../modules.md#transferrestrictions-1) | The transfer restrictions for the claim. | -| `overrides?` | [`SupportedOverrides`](../modules.md#supportedoverrides) | Optional overrides for the contract call. | - -#### Returns - -`Promise`<`undefined` \| \`0x$\{string}\`\> - -A promise that resolves to the transaction hash. - -**`Throws`** - -Will throw a `MalformedDataError` if the provided metadata is invalid. - -#### Implementation of - -[HypercertClientInterface](../interfaces/HypercertClientInterface.md).[mintClaim](../interfaces/HypercertClientInterface.md#mintclaim) - -#### Defined in - -[sdk/src/client.ts:131](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/client.ts#L131) - ---- - -### mintClaimFractionFromAllowlist - -▸ **mintClaimFractionFromAllowlist**(`claimId`, `units`, `proof`, `root?`, `overrides?`): `Promise`<`undefined` \| \`0x$\{string}\`\> - -Mints a claim fraction from an allowlist. - -This method first retrieves the wallet client and account using the `getWallet` method. It then verifies the provided proof using the `verifyMerkleProof` function. If the proof is invalid, it throws an `InvalidOrMissingError`. -It then simulates a contract call to the `mintClaimFromAllowlist` function with the provided parameters and the account, and submits the request using the `submitRequest` method. - -#### Parameters - -| Name | Type | Description | -| :----------- | :------------------------------------------------------- | :------------------------------------------------------------------ | -| `claimId` | `bigint` | The ID of the claim to mint. | -| `units` | `bigint` | The units of the claim to mint. | -| `proof` | (\`0x$\{string}\` \| `Uint8Array`)[] | The proof for the claim. | -| `root?` | \`0x$\{string}\` \| `Uint8Array` | The root of the proof. If provided, it is used to verify the proof. | -| `overrides?` | [`SupportedOverrides`](../modules.md#supportedoverrides) | Optional overrides for the contract call. | - -#### Returns - -`Promise`<`undefined` \| \`0x$\{string}\`\> - -A promise that resolves to the transaction hash. - -**`Throws`** - -Will throw an `InvalidOrMissingError` if the proof is invalid. - -#### Implementation of - -[HypercertClientInterface](../interfaces/HypercertClientInterface.md).[mintClaimFractionFromAllowlist](../interfaces/HypercertClientInterface.md#mintclaimfractionfromallowlist) - -#### Defined in - -[sdk/src/client.ts:404](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/client.ts#L404) - ---- - -### simulateRequest - -▸ **simulateRequest**(`account`, `functionName`, `args`, `overrides?`): `Promise`<\{ `abi`: readonly [`never`] ; `accessList?`: `undefined` ; `account`: `JsonRpcAccount`<\`0x$\{string}\`\> ; `address`: \`0x$\{string}\` ; `args?`: readonly `unknown`[] ; `blobs?`: `undefined` ; `chain`: `undefined` \| `Chain` ; `dataSuffix?`: \`0x$\{string}\` ; `functionName`: `string` ; `gas?`: `bigint` ; `gasPrice?`: `bigint` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce?`: `number` ; `type?`: ``"legacy"`` ; `value?`: `bigint` } \| \{ `abi`: readonly [`never`] ; `accessList?`: `undefined` ; `account`: `LocalAccount`<`string`, \`0x$\{string}\`\> ; `address`: \`0x$\{string}\` ; `args?`: readonly `unknown`[] ; `blobs?`: `undefined` ; `chain`: `undefined` \| `Chain` ; `dataSuffix?`: \`0x$\{string}\` ; `functionName`: `string` ; `gas?`: `bigint` ; `gasPrice?`: `bigint` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce?`: `number` ; `type?`: `"legacy"` ; `value?`: `bigint` } \| \{ `abi`: readonly [`never`] ; `accessList?`: `AccessList` ; `account`: `JsonRpcAccount`<\`0x$\{string}\`\> ; `address`: \`0x$\{string}\` ; `args?`: readonly `unknown`[] ; `blobs?`: `undefined` ; `chain`: `undefined` \| `Chain` ; `dataSuffix?`: \`0x$\{string}\` ; `functionName`: `string` ; `gas?`: `bigint` ; `gasPrice?`: `bigint` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce?`: `number` ; `type?`: ``"eip2930"`` ; `value?`: `bigint` } \| \{ `abi`: readonly [`never`] ; `accessList?`: `AccessList` ; `account`: `LocalAccount`<`string`, \`0x$\{string}\`\> ; `address`: \`0x$\{string}\` ; `args?`: readonly `unknown`[] ; `blobs?`: `undefined` ; `chain`: `undefined` \| `Chain` ; `dataSuffix?`: \`0x$\{string}\` ; `functionName`: `string` ; `gas?`: `bigint` ; `gasPrice?`: `bigint` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce?`: `number` ; `type?`: `"eip2930"` ; `value?`: `bigint` } \| \{ `abi`: readonly [`never`] ; `accessList?`: `AccessList` ; `account`: `JsonRpcAccount`<\`0x$\{string}\`\> ; `address`: \`0x$\{string}\` ; `args?`: readonly `unknown`[] ; `blobs?`: `undefined` ; `chain`: `undefined` \| `Chain` ; `dataSuffix?`: \`0x$\{string}\` ; `functionName`: `string` ; `gas?`: `bigint` ; `gasPrice?`: `undefined` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `bigint` ; `maxPriorityFeePerGas?`: `bigint` ; `nonce?`: `number` ; `type?`: ``"eip1559"`` ; `value?`: `bigint` } \| \{ `abi`: readonly [`never`] ; `accessList?`: `AccessList` ; `account`: `LocalAccount`<`string`, \`0x$\{string}\`\> ; `address`: \`0x$\{string}\` ; `args?`: readonly `unknown`[] ; `blobs?`: `undefined` ; `chain`: `undefined` \| `Chain` ; `dataSuffix?`: \`0x$\{string}\` ; `functionName`: `string` ; `gas?`: `bigint` ; `gasPrice?`: `undefined` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `bigint` ; `maxPriorityFeePerGas?`: `bigint` ; `nonce?`: `number` ; `type?`: `"eip1559"` ; `value?`: `bigint` } \| \{ `abi`: readonly [`never`] ; `accessList?`: `AccessList` ; `account`: `JsonRpcAccount`<\`0x$\{string}\`\> ; `address`: \`0x$\{string}\` ; `args?`: readonly `unknown`[] ; `blobs`: readonly \`0x$\{string}\`[] \| readonly `Uint8Array`[] ; `chain`: `undefined` \| `Chain` ; `dataSuffix?`: \`0x$\{string}\` ; `functionName`: `string` ; `gas?`: `bigint` ; `gasPrice?`: `undefined` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas?`: `bigint` ; `maxPriorityFeePerGas?`: `bigint` ; `nonce?`: `number` ; `type?`: `"eip4844"` ; `value?`: `bigint` } \| \{ `abi`: readonly [`never`] ; `accessList?`: `AccessList` ; `account`: `LocalAccount`<`string`, \`0x$\{string}\`\> ; `address`: \`0x$\{string}\` ; `args?`: readonly `unknown`[] ; `blobs`: readonly \`0x$\{string}\`[] \| readonly `Uint8Array`[] ; `chain`: `undefined` \| `Chain` ; `dataSuffix?`: \`0x$\{string}\` ; `functionName`: `string` ; `gas?`: `bigint` ; `gasPrice?`: `undefined` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas?`: `bigint` ; `maxPriorityFeePerGas?`: `bigint` ; `nonce?`: `number` ; `type?`: `"eip4844"` ; `value?`: `bigint` }\> - -#### Parameters - -| Name | Type | -| :------------- | :------------------------------------------------------- | -| `account` | `Account` | -| `functionName` | `string` | -| `args` | `unknown`[] | -| `overrides?` | [`SupportedOverrides`](../modules.md#supportedoverrides) | - -#### Returns - -`Promise`<\{ `abi`: readonly [`never`] ; `accessList?`: `undefined` ; `account`: `JsonRpcAccount`<\`0x$\{string}\`\> ; `address`: \`0x$\{string}\` ; `args?`: readonly `unknown`[] ; `blobs?`: `undefined` ; `chain`: `undefined` \| `Chain` ; `dataSuffix?`: \`0x$\{string}\` ; `functionName`: `string` ; `gas?`: `bigint` ; `gasPrice?`: `bigint` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce?`: `number` ; `type?`: ``"legacy"`` ; `value?`: `bigint` } \| \{ `abi`: readonly [`never`] ; `accessList?`: `undefined` ; `account`: `LocalAccount`<`string`, \`0x$\{string}\`\> ; `address`: \`0x$\{string}\` ; `args?`: readonly `unknown`[] ; `blobs?`: `undefined` ; `chain`: `undefined` \| `Chain` ; `dataSuffix?`: \`0x$\{string}\` ; `functionName`: `string` ; `gas?`: `bigint` ; `gasPrice?`: `bigint` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce?`: `number` ; `type?`: `"legacy"` ; `value?`: `bigint` } \| \{ `abi`: readonly [`never`] ; `accessList?`: `AccessList` ; `account`: `JsonRpcAccount`<\`0x$\{string}\`\> ; `address`: \`0x$\{string}\` ; `args?`: readonly `unknown`[] ; `blobs?`: `undefined` ; `chain`: `undefined` \| `Chain` ; `dataSuffix?`: \`0x$\{string}\` ; `functionName`: `string` ; `gas?`: `bigint` ; `gasPrice?`: `bigint` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce?`: `number` ; `type?`: ``"eip2930"`` ; `value?`: `bigint` } \| \{ `abi`: readonly [`never`] ; `accessList?`: `AccessList` ; `account`: `LocalAccount`<`string`, \`0x$\{string}\`\> ; `address`: \`0x$\{string}\` ; `args?`: readonly `unknown`[] ; `blobs?`: `undefined` ; `chain`: `undefined` \| `Chain` ; `dataSuffix?`: \`0x$\{string}\` ; `functionName`: `string` ; `gas?`: `bigint` ; `gasPrice?`: `bigint` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce?`: `number` ; `type?`: `"eip2930"` ; `value?`: `bigint` } \| \{ `abi`: readonly [`never`] ; `accessList?`: `AccessList` ; `account`: `JsonRpcAccount`<\`0x$\{string}\`\> ; `address`: \`0x$\{string}\` ; `args?`: readonly `unknown`[] ; `blobs?`: `undefined` ; `chain`: `undefined` \| `Chain` ; `dataSuffix?`: \`0x$\{string}\` ; `functionName`: `string` ; `gas?`: `bigint` ; `gasPrice?`: `undefined` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `bigint` ; `maxPriorityFeePerGas?`: `bigint` ; `nonce?`: `number` ; `type?`: ``"eip1559"`` ; `value?`: `bigint` } \| \{ `abi`: readonly [`never`] ; `accessList?`: `AccessList` ; `account`: `LocalAccount`<`string`, \`0x$\{string}\`\> ; `address`: \`0x$\{string}\` ; `args?`: readonly `unknown`[] ; `blobs?`: `undefined` ; `chain`: `undefined` \| `Chain` ; `dataSuffix?`: \`0x$\{string}\` ; `functionName`: `string` ; `gas?`: `bigint` ; `gasPrice?`: `undefined` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `bigint` ; `maxPriorityFeePerGas?`: `bigint` ; `nonce?`: `number` ; `type?`: `"eip1559"` ; `value?`: `bigint` } \| \{ `abi`: readonly [`never`] ; `accessList?`: `AccessList` ; `account`: `JsonRpcAccount`<\`0x$\{string}\`\> ; `address`: \`0x$\{string}\` ; `args?`: readonly `unknown`[] ; `blobs`: readonly \`0x$\{string}\`[] \| readonly `Uint8Array`[] ; `chain`: `undefined` \| `Chain` ; `dataSuffix?`: \`0x$\{string}\` ; `functionName`: `string` ; `gas?`: `bigint` ; `gasPrice?`: `undefined` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas?`: `bigint` ; `maxPriorityFeePerGas?`: `bigint` ; `nonce?`: `number` ; `type?`: `"eip4844"` ; `value?`: `bigint` } \| \{ `abi`: readonly [`never`] ; `accessList?`: `AccessList` ; `account`: `LocalAccount`<`string`, \`0x$\{string}\`\> ; `address`: \`0x$\{string}\` ; `args?`: readonly `unknown`[] ; `blobs`: readonly \`0x$\{string}\`[] \| readonly `Uint8Array`[] ; `chain`: `undefined` \| `Chain` ; `dataSuffix?`: \`0x$\{string}\` ; `functionName`: `string` ; `gas?`: `bigint` ; `gasPrice?`: `undefined` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas?`: `bigint` ; `maxPriorityFeePerGas?`: `bigint` ; `nonce?`: `number` ; `type?`: `"eip4844"` ; `value?`: `bigint` }\> - -#### Defined in - -[sdk/src/client.ts:516](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/client.ts#L516) - ---- - -### splitFractionUnits - -▸ **splitFractionUnits**(`fractionId`, `fractions`, `overrides?`): `Promise`<`undefined` \| \`0x$\{string}\`\> - -Splits a fraction into multiple fractions. - -This method first retrieves the wallet client and account using the `getWallet` method. It then retrieves the owner and total units of the fraction using the `ownerOf` and `unitsOf` methods of the read contract. -If the fraction is not owned by the account, it throws a `ClientError`. -It then checks if the sum of the provided fractions is equal to the total units of the fraction. If not, it throws a `ClientError`. -Finally, it simulates a contract call to the `splitFraction` function with the provided parameters and the account, and submits the request using the `submitRequest` method. - -#### Parameters - -| Name | Type | Description | -| :----------- | :------------------------------------------------------- | :---------------------------------------- | -| `fractionId` | `bigint` | The ID of the fraction to split. | -| `fractions` | `bigint`[] | The fractions to split the fraction into. | -| `overrides?` | [`SupportedOverrides`](../modules.md#supportedoverrides) | Optional overrides for the contract call. | - -#### Returns - -`Promise`<`undefined` \| \`0x$\{string}\`\> - -A promise that resolves to the transaction hash. - -**`Throws`** - -Will throw a `ClientError` if the fraction is not owned by the account or if the sum of the fractions is not equal to the total units of the fraction. - -#### Implementation of - -[HypercertClientInterface](../interfaces/HypercertClientInterface.md).[splitFractionUnits](../interfaces/HypercertClientInterface.md#splitfractionunits) - -#### Defined in - -[sdk/src/client.ts:285](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/client.ts#L285) - ---- - -### submitRequest - -▸ **submitRequest**(`request`): `Promise`<\`0x$\{string}\`\> - -Submits a contract request. - -This method submits a contract request using the `writeContract` method of the wallet client. If the request fails, it throws a `ClientError`. - -#### Parameters - -| Name | Type | Description | -| :-------- | :---- | :------------------------------ | -| `request` | `any` | The contract request to submit. | - -#### Returns - -`Promise`<\`0x$\{string}\`\> - -A promise that resolves to the hash of the submitted request. - -**`Throws`** - -Will throw a `ClientError` if the request fails. - -#### Defined in - -[sdk/src/client.ts:551](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/client.ts#L551) - ---- - -### transferFraction - -▸ **transferFraction**(`fractionId`, `to`, `overrides?`): `Promise`<`undefined` \| \`0x$\{string}\`\> - -Transfers a claim fraction to a new owner. - -This method first retrieves the wallet client and account using the `getWallet` method. -It then simulates a contract call to the `safeTransferFrom` function with the provided parameters and the account, and submits the request using the `submitRequest` method. - -#### Parameters - -| Name | Type | -| :----------- | :------------------------------------------------------- | -| `fractionId` | `bigint` | -| `to` | `string` | -| `overrides?` | [`SupportedOverrides`](../modules.md#supportedoverrides) | - -#### Returns - -`Promise`<`undefined` \| \`0x$\{string}\`\> - -A promise that resolves to the transaction hash. - -#### Implementation of - -[HypercertClientInterface](../interfaces/HypercertClientInterface.md).[transferFraction](../interfaces/HypercertClientInterface.md#transferfraction) - -#### Defined in - -[sdk/src/client.ts:180](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/client.ts#L180) diff --git a/docs/docs/developer/api/sdk/classes/HypercertsStorage.md b/docs/docs/developer/api/sdk/classes/HypercertsStorage.md deleted file mode 100644 index f26c02ff..00000000 --- a/docs/docs/developer/api/sdk/classes/HypercertsStorage.md +++ /dev/null @@ -1,192 +0,0 @@ ---- -id: "HypercertsStorage" -title: "Class: HypercertsStorage" -sidebar_label: "HypercertsStorage" -sidebar_position: 0 -custom_edit_url: null ---- - -A class that provides storage functionality for Hypercerts. - -This class implements the `HypercertStorageInterface` and provides methods for storing and retrieving Hypercerts. - -**`Example`** - -```ts -const storage = new HypercertsStorage(); -const metadata = await storage.getMetadata("your-hypercert-id"); -``` - -## Implements - -- [`HypercertStorageInterface`](../interfaces/HypercertStorageInterface.md) - -## Constructors - -### constructor - -• **new HypercertsStorage**(): [`HypercertsStorage`](HypercertsStorage.md) - -#### Returns - -[`HypercertsStorage`](HypercertsStorage.md) - -## Methods - -### getData - -▸ **getData**(`cidOrIpfsUri`, `config?`): `Promise`<`unknown`\> - -Retrieves data from IPFS using the provided CID or IPFS URI. - -This method first retrieves the data from IPFS using the `getFromIPFS` function. It then parses the retrieved data as JSON and returns it. - -#### Parameters - -| Name | Type | Description | -| :------------- | :--------------------------------------------------------------- | :------------------------------------------- | -| `cidOrIpfsUri` | `string` | The CID or IPFS URI of the data to retrieve. | -| `config?` | [`StorageConfigOverrides`](../modules.md#storageconfigoverrides) | An optional configuration object. | - -#### Returns - -`Promise`<`unknown`\> - -A promise that resolves to the retrieved data. - -**`Throws`** - -Will throw a `FetchError` if the retrieval operation fails. - -**`Throws`** - -Will throw a `MalformedDataError` if the retrieved data is not a single file. - -**`Remarkts`** - -Note: The original implementation using the Web3 Storage client is currently commented out due to issues with upstream repos. This will be replaced once those issues are resolved. - -#### Implementation of - -[HypercertStorageInterface](../interfaces/HypercertStorageInterface.md).[getData](../interfaces/HypercertStorageInterface.md#getdata) - -#### Defined in - -[sdk/src/storage.ts:145](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/storage.ts#L145) - ---- - -### getMetadata - -▸ **getMetadata**(`cidOrIpfsUri`, `config?`): `Promise`<[`HypercertMetadata`](../interfaces/HypercertMetadata.md)\> - -Retrieves Hypercert metadata from IPFS using the provided CID or IPFS URI. - -This method first retrieves the data from IPFS using the `getFromIPFS` function. It then validates the retrieved data using the `validateMetaData` function. If the data is invalid, it throws a `MalformedDataError`. -If the data is valid, it returns the data as a `HypercertMetadata` object. - -#### Parameters - -| Name | Type | Description | -| :------------- | :--------------------------------------------------------------- | :----------------------------------------------- | -| `cidOrIpfsUri` | `string` | The CID or IPFS URI of the metadata to retrieve. | -| `config?` | [`StorageConfigOverrides`](../modules.md#storageconfigoverrides) | An optional configuration object. | - -#### Returns - -`Promise`<[`HypercertMetadata`](../interfaces/HypercertMetadata.md)\> - -A promise that resolves to the retrieved metadata. - -**`Throws`** - -Will throw a `MalformedDataError` if the retrieved data is invalid. - -#### Implementation of - -[HypercertStorageInterface](../interfaces/HypercertStorageInterface.md).[getMetadata](../interfaces/HypercertStorageInterface.md#getmetadata) - -#### Defined in - -[sdk/src/storage.ts:118](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/storage.ts#L118) - ---- - -### storeAllowList - -▸ **storeAllowList**(`allowList`, `totalUnits`, `config?`): `Promise`<`string`\> - -Stores hypercerts allowlist on IPFS. - -First it validates the provided metadata using the `validateMetaData` function. If the metadata is invalid, it throws a `MalformedDataError`. -If the metadata is valid, it creates a new Blob from the metadata and stores it using the hypercerts API. If the storage operation fails, it throws a `StorageError`. - -#### Parameters - -| Name | Type | Description | -| :----------- | :--------------------------------------------------------------- | :------------------------------------------ | -| `allowList` | [`AllowlistEntry`](../modules.md#allowlistentry)[] | The allowList to store. | -| `totalUnits` | `bigint` | The total number of units in the allowlist. | -| `config?` | [`StorageConfigOverrides`](../modules.md#storageconfigoverrides) | An optional configuration object. | - -#### Returns - -`Promise`<`string`\> - -A promise that resolves to the CID of the stored metadata. - -**`Throws`** - -Will throw a `StorageError` if the storage operation fails. - -**`Throws`** - -Will throw a `MalformedDataError` if the provided metadata is invalid. - -#### Implementation of - -[HypercertStorageInterface](../interfaces/HypercertStorageInterface.md).[storeAllowList](../interfaces/HypercertStorageInterface.md#storeallowlist) - -#### Defined in - -[sdk/src/storage.ts:36](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/storage.ts#L36) - ---- - -### storeMetadata - -▸ **storeMetadata**(`metadata`, `config?`): `Promise`<`string`\> - -Stores Hypercert metadata using the hypercerts API. - -It then validates the provided metadata using the `validateMetaData` function. If the metadata is invalid, it throws a `MalformedDataError`. -If the metadata is valid, it creates a new Blob from the metadata and stores it using the hypercerts API. If the storage operation fails, it throws a `StorageError`. - -#### Parameters - -| Name | Type | Description | -| :--------- | :--------------------------------------------------------------- | :-------------------------------- | -| `metadata` | [`HypercertMetadata`](../interfaces/HypercertMetadata.md) | - | -| `config?` | [`StorageConfigOverrides`](../modules.md#storageconfigoverrides) | An optional configuration object. | - -#### Returns - -`Promise`<`string`\> - -A promise that resolves to the CID of the stored metadata. - -**`Throws`** - -Will throw a `StorageError` if the storage operation fails. - -**`Throws`** - -Will throw a `MalformedDataError` if the provided metadata is invalid. - -#### Implementation of - -[HypercertStorageInterface](../interfaces/HypercertStorageInterface.md).[storeMetadata](../interfaces/HypercertStorageInterface.md#storemetadata) - -#### Defined in - -[sdk/src/storage.ts:83](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/storage.ts#L83) diff --git a/docs/docs/developer/api/sdk/classes/InvalidOrMissingError.md b/docs/docs/developer/api/sdk/classes/InvalidOrMissingError.md deleted file mode 100644 index 91b6fab3..00000000 --- a/docs/docs/developer/api/sdk/classes/InvalidOrMissingError.md +++ /dev/null @@ -1,198 +0,0 @@ ---- -id: "InvalidOrMissingError" -title: "Class: InvalidOrMissingError" -sidebar_label: "InvalidOrMissingError" -sidebar_position: 0 -custom_edit_url: null ---- - -The provided value was undefined or empty - -## Hierarchy - -- `Error` - - ↳ **`InvalidOrMissingError`** - -## Implements - -- [`CustomError`](../interfaces/CustomError.md) - -## Constructors - -### constructor - -• **new InvalidOrMissingError**(`message`, `payload?`): [`InvalidOrMissingError`](InvalidOrMissingError.md) - -Creates a new instance of the InvalidOrMissingError class. - -#### Parameters - -| Name | Type | Description | -| :--------- | :------- | :------------------------ | -| `message` | `string` | The error message. | -| `payload?` | `Object` | Additional error payload. | - -#### Returns - -[`InvalidOrMissingError`](InvalidOrMissingError.md) - -#### Overrides - -Error.constructor - -#### Defined in - -[sdk/src/types/errors.ts:83](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/errors.ts#L83) - -## Properties - -### cause - -• `Optional` **cause**: `unknown` - -#### Inherited from - -Error.cause - -#### Defined in - -node_modules/.pnpm/typescript@5.3.2/node_modules/typescript/lib/lib.es2022.error.d.ts:24 - ---- - -### message - -• **message**: `string` - -#### Inherited from - -Error.message - -#### Defined in - -node_modules/.pnpm/typescript@5.3.2/node_modules/typescript/lib/lib.es5.d.ts:1076 - ---- - -### name - -• **name**: `string` - -#### Inherited from - -Error.name - -#### Defined in - -node_modules/.pnpm/typescript@5.3.2/node_modules/typescript/lib/lib.es5.d.ts:1075 - ---- - -### payload - -• `Optional` **payload**: `Object` - -Additional error payload. - -#### Index signature - -▪ [key: `string`]: `unknown` - -#### Implementation of - -[CustomError](../interfaces/CustomError.md).[payload](../interfaces/CustomError.md#payload) - -#### Defined in - -[sdk/src/types/errors.ts:76](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/errors.ts#L76) - ---- - -### stack - -• `Optional` **stack**: `string` - -#### Inherited from - -Error.stack - -#### Defined in - -node_modules/.pnpm/typescript@5.3.2/node_modules/typescript/lib/lib.es5.d.ts:1077 - ---- - -### prepareStackTrace - -▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` - -#### Type declaration - -▸ (`err`, `stackTraces`): `any` - -Optional override for formatting stack traces - -##### Parameters - -| Name | Type | -| :------------ | :----------- | -| `err` | `Error` | -| `stackTraces` | `CallSite`[] | - -##### Returns - -`any` - -**`See`** - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - -#### Inherited from - -Error.prepareStackTrace - -#### Defined in - -node_modules/.pnpm/@types+node@18.18.7/node_modules/@types/node/globals.d.ts:11 - ---- - -### stackTraceLimit - -▪ `Static` **stackTraceLimit**: `number` - -#### Inherited from - -Error.stackTraceLimit - -#### Defined in - -node_modules/.pnpm/@types+node@18.18.7/node_modules/@types/node/globals.d.ts:13 - -## Methods - -### captureStackTrace - -▸ **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` - -Create .stack property on a target object - -#### Parameters - -| Name | Type | -| :---------------- | :--------- | -| `targetObject` | `object` | -| `constructorOpt?` | `Function` | - -#### Returns - -`void` - -#### Inherited from - -Error.captureStackTrace - -#### Defined in - -node_modules/.pnpm/@types+node@18.18.7/node_modules/@types/node/globals.d.ts:4 diff --git a/docs/docs/developer/api/sdk/classes/MalformedDataError.md b/docs/docs/developer/api/sdk/classes/MalformedDataError.md deleted file mode 100644 index d11a0869..00000000 --- a/docs/docs/developer/api/sdk/classes/MalformedDataError.md +++ /dev/null @@ -1,198 +0,0 @@ ---- -id: "MalformedDataError" -title: "Class: MalformedDataError" -sidebar_label: "MalformedDataError" -sidebar_position: 0 -custom_edit_url: null ---- - -Data doesn't conform to expectations - -## Hierarchy - -- `Error` - - ↳ **`MalformedDataError`** - -## Implements - -- [`CustomError`](../interfaces/CustomError.md) - -## Constructors - -### constructor - -• **new MalformedDataError**(`message`, `payload?`): [`MalformedDataError`](MalformedDataError.md) - -Creates a new instance of the MalformedDataError class. - -#### Parameters - -| Name | Type | Description | -| :--------- | :------- | :------------------------ | -| `message` | `string` | The error message. | -| `payload?` | `Object` | Additional error payload. | - -#### Returns - -[`MalformedDataError`](MalformedDataError.md) - -#### Overrides - -Error.constructor - -#### Defined in - -[sdk/src/types/errors.ts:155](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/errors.ts#L155) - -## Properties - -### cause - -• `Optional` **cause**: `unknown` - -#### Inherited from - -Error.cause - -#### Defined in - -node_modules/.pnpm/typescript@5.3.2/node_modules/typescript/lib/lib.es2022.error.d.ts:24 - ---- - -### message - -• **message**: `string` - -#### Inherited from - -Error.message - -#### Defined in - -node_modules/.pnpm/typescript@5.3.2/node_modules/typescript/lib/lib.es5.d.ts:1076 - ---- - -### name - -• **name**: `string` - -#### Inherited from - -Error.name - -#### Defined in - -node_modules/.pnpm/typescript@5.3.2/node_modules/typescript/lib/lib.es5.d.ts:1075 - ---- - -### payload - -• `Optional` **payload**: `Object` - -Additional error payload. - -#### Index signature - -▪ [key: `string`]: `unknown` - -#### Implementation of - -[CustomError](../interfaces/CustomError.md).[payload](../interfaces/CustomError.md#payload) - -#### Defined in - -[sdk/src/types/errors.ts:148](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/errors.ts#L148) - ---- - -### stack - -• `Optional` **stack**: `string` - -#### Inherited from - -Error.stack - -#### Defined in - -node_modules/.pnpm/typescript@5.3.2/node_modules/typescript/lib/lib.es5.d.ts:1077 - ---- - -### prepareStackTrace - -▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` - -#### Type declaration - -▸ (`err`, `stackTraces`): `any` - -Optional override for formatting stack traces - -##### Parameters - -| Name | Type | -| :------------ | :----------- | -| `err` | `Error` | -| `stackTraces` | `CallSite`[] | - -##### Returns - -`any` - -**`See`** - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - -#### Inherited from - -Error.prepareStackTrace - -#### Defined in - -node_modules/.pnpm/@types+node@18.18.7/node_modules/@types/node/globals.d.ts:11 - ---- - -### stackTraceLimit - -▪ `Static` **stackTraceLimit**: `number` - -#### Inherited from - -Error.stackTraceLimit - -#### Defined in - -node_modules/.pnpm/@types+node@18.18.7/node_modules/@types/node/globals.d.ts:13 - -## Methods - -### captureStackTrace - -▸ **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` - -Create .stack property on a target object - -#### Parameters - -| Name | Type | -| :---------------- | :--------- | -| `targetObject` | `object` | -| `constructorOpt?` | `Function` | - -#### Returns - -`void` - -#### Inherited from - -Error.captureStackTrace - -#### Defined in - -node_modules/.pnpm/@types+node@18.18.7/node_modules/@types/node/globals.d.ts:4 diff --git a/docs/docs/developer/api/sdk/classes/MintingError.md b/docs/docs/developer/api/sdk/classes/MintingError.md deleted file mode 100644 index 6c66e904..00000000 --- a/docs/docs/developer/api/sdk/classes/MintingError.md +++ /dev/null @@ -1,198 +0,0 @@ ---- -id: "MintingError" -title: "Class: MintingError" -sidebar_label: "MintingError" -sidebar_position: 0 -custom_edit_url: null ---- - -Minting transaction failed - -## Hierarchy - -- `Error` - - ↳ **`MintingError`** - -## Implements - -- [`CustomError`](../interfaces/CustomError.md) - -## Constructors - -### constructor - -• **new MintingError**(`message`, `payload?`): [`MintingError`](MintingError.md) - -Creates a new instance of the MintingError class. - -#### Parameters - -| Name | Type | Description | -| :--------- | :------- | :------------------------ | -| `message` | `string` | The error message. | -| `payload?` | `Object` | Additional error payload. | - -#### Returns - -[`MintingError`](MintingError.md) - -#### Overrides - -Error.constructor - -#### Defined in - -[sdk/src/types/errors.ts:101](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/errors.ts#L101) - -## Properties - -### cause - -• `Optional` **cause**: `unknown` - -#### Inherited from - -Error.cause - -#### Defined in - -node_modules/.pnpm/typescript@5.3.2/node_modules/typescript/lib/lib.es2022.error.d.ts:24 - ---- - -### message - -• **message**: `string` - -#### Inherited from - -Error.message - -#### Defined in - -node_modules/.pnpm/typescript@5.3.2/node_modules/typescript/lib/lib.es5.d.ts:1076 - ---- - -### name - -• **name**: `string` - -#### Inherited from - -Error.name - -#### Defined in - -node_modules/.pnpm/typescript@5.3.2/node_modules/typescript/lib/lib.es5.d.ts:1075 - ---- - -### payload - -• `Optional` **payload**: `Object` - -Additional error payload. - -#### Index signature - -▪ [key: `string`]: `unknown` - -#### Implementation of - -[CustomError](../interfaces/CustomError.md).[payload](../interfaces/CustomError.md#payload) - -#### Defined in - -[sdk/src/types/errors.ts:94](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/errors.ts#L94) - ---- - -### stack - -• `Optional` **stack**: `string` - -#### Inherited from - -Error.stack - -#### Defined in - -node_modules/.pnpm/typescript@5.3.2/node_modules/typescript/lib/lib.es5.d.ts:1077 - ---- - -### prepareStackTrace - -▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` - -#### Type declaration - -▸ (`err`, `stackTraces`): `any` - -Optional override for formatting stack traces - -##### Parameters - -| Name | Type | -| :------------ | :----------- | -| `err` | `Error` | -| `stackTraces` | `CallSite`[] | - -##### Returns - -`any` - -**`See`** - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - -#### Inherited from - -Error.prepareStackTrace - -#### Defined in - -node_modules/.pnpm/@types+node@18.18.7/node_modules/@types/node/globals.d.ts:11 - ---- - -### stackTraceLimit - -▪ `Static` **stackTraceLimit**: `number` - -#### Inherited from - -Error.stackTraceLimit - -#### Defined in - -node_modules/.pnpm/@types+node@18.18.7/node_modules/@types/node/globals.d.ts:13 - -## Methods - -### captureStackTrace - -▸ **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` - -Create .stack property on a target object - -#### Parameters - -| Name | Type | -| :---------------- | :--------- | -| `targetObject` | `object` | -| `constructorOpt?` | `Function` | - -#### Returns - -`void` - -#### Inherited from - -Error.captureStackTrace - -#### Defined in - -node_modules/.pnpm/@types+node@18.18.7/node_modules/@types/node/globals.d.ts:4 diff --git a/docs/docs/developer/api/sdk/classes/StorageError.md b/docs/docs/developer/api/sdk/classes/StorageError.md deleted file mode 100644 index 096b4a4e..00000000 --- a/docs/docs/developer/api/sdk/classes/StorageError.md +++ /dev/null @@ -1,198 +0,0 @@ ---- -id: "StorageError" -title: "Class: StorageError" -sidebar_label: "StorageError" -sidebar_position: 0 -custom_edit_url: null ---- - -Fails storing to a remote resource - -## Hierarchy - -- `Error` - - ↳ **`StorageError`** - -## Implements - -- [`CustomError`](../interfaces/CustomError.md) - -## Constructors - -### constructor - -• **new StorageError**(`message`, `payload?`): [`StorageError`](StorageError.md) - -Creates a new instance of the StorageError class. - -#### Parameters - -| Name | Type | Description | -| :--------- | :------- | :------------------------ | -| `message` | `string` | The error message. | -| `payload?` | `Object` | Additional error payload. | - -#### Returns - -[`StorageError`](StorageError.md) - -#### Overrides - -Error.constructor - -#### Defined in - -[sdk/src/types/errors.ts:119](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/errors.ts#L119) - -## Properties - -### cause - -• `Optional` **cause**: `unknown` - -#### Inherited from - -Error.cause - -#### Defined in - -node_modules/.pnpm/typescript@5.3.2/node_modules/typescript/lib/lib.es2022.error.d.ts:24 - ---- - -### message - -• **message**: `string` - -#### Inherited from - -Error.message - -#### Defined in - -node_modules/.pnpm/typescript@5.3.2/node_modules/typescript/lib/lib.es5.d.ts:1076 - ---- - -### name - -• **name**: `string` - -#### Inherited from - -Error.name - -#### Defined in - -node_modules/.pnpm/typescript@5.3.2/node_modules/typescript/lib/lib.es5.d.ts:1075 - ---- - -### payload - -• `Optional` **payload**: `Object` - -Additional error payload. - -#### Index signature - -▪ [key: `string`]: `unknown` - -#### Implementation of - -[CustomError](../interfaces/CustomError.md).[payload](../interfaces/CustomError.md#payload) - -#### Defined in - -[sdk/src/types/errors.ts:112](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/errors.ts#L112) - ---- - -### stack - -• `Optional` **stack**: `string` - -#### Inherited from - -Error.stack - -#### Defined in - -node_modules/.pnpm/typescript@5.3.2/node_modules/typescript/lib/lib.es5.d.ts:1077 - ---- - -### prepareStackTrace - -▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` - -#### Type declaration - -▸ (`err`, `stackTraces`): `any` - -Optional override for formatting stack traces - -##### Parameters - -| Name | Type | -| :------------ | :----------- | -| `err` | `Error` | -| `stackTraces` | `CallSite`[] | - -##### Returns - -`any` - -**`See`** - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - -#### Inherited from - -Error.prepareStackTrace - -#### Defined in - -node_modules/.pnpm/@types+node@18.18.7/node_modules/@types/node/globals.d.ts:11 - ---- - -### stackTraceLimit - -▪ `Static` **stackTraceLimit**: `number` - -#### Inherited from - -Error.stackTraceLimit - -#### Defined in - -node_modules/.pnpm/@types+node@18.18.7/node_modules/@types/node/globals.d.ts:13 - -## Methods - -### captureStackTrace - -▸ **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` - -Create .stack property on a target object - -#### Parameters - -| Name | Type | -| :---------------- | :--------- | -| `targetObject` | `object` | -| `constructorOpt?` | `Function` | - -#### Returns - -`void` - -#### Inherited from - -Error.captureStackTrace - -#### Defined in - -node_modules/.pnpm/@types+node@18.18.7/node_modules/@types/node/globals.d.ts:4 diff --git a/docs/docs/developer/api/sdk/classes/UnknownSchemaError.md b/docs/docs/developer/api/sdk/classes/UnknownSchemaError.md deleted file mode 100644 index 928c8071..00000000 --- a/docs/docs/developer/api/sdk/classes/UnknownSchemaError.md +++ /dev/null @@ -1,201 +0,0 @@ ---- -id: "UnknownSchemaError" -title: "Class: UnknownSchemaError" -sidebar_label: "UnknownSchemaError" -sidebar_position: 0 -custom_edit_url: null ---- - -Schema could not be loaded - -## Hierarchy - -- `Error` - - ↳ **`UnknownSchemaError`** - -## Implements - -- [`CustomError`](../interfaces/CustomError.md) - -## Constructors - -### constructor - -• **new UnknownSchemaError**(`message`, `payload?`): [`UnknownSchemaError`](UnknownSchemaError.md) - -Creates a new instance of the UnknownSchemaError class. - -#### Parameters - -| Name | Type | Description | -| :------------------- | :------- | :------------------------ | -| `message` | `string` | The error message. | -| `payload?` | `Object` | Additional error payload. | -| `payload.schemaName` | `string` | - | - -#### Returns - -[`UnknownSchemaError`](UnknownSchemaError.md) - -#### Overrides - -Error.constructor - -#### Defined in - -[sdk/src/types/errors.ts:137](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/errors.ts#L137) - -## Properties - -### cause - -• `Optional` **cause**: `unknown` - -#### Inherited from - -Error.cause - -#### Defined in - -node_modules/.pnpm/typescript@5.3.2/node_modules/typescript/lib/lib.es2022.error.d.ts:24 - ---- - -### message - -• **message**: `string` - -#### Inherited from - -Error.message - -#### Defined in - -node_modules/.pnpm/typescript@5.3.2/node_modules/typescript/lib/lib.es5.d.ts:1076 - ---- - -### name - -• **name**: `string` - -#### Inherited from - -Error.name - -#### Defined in - -node_modules/.pnpm/typescript@5.3.2/node_modules/typescript/lib/lib.es5.d.ts:1075 - ---- - -### payload - -• `Optional` **payload**: `Object` - -Additional error payload. - -#### Type declaration - -| Name | Type | -| :----------- | :------- | -| `schemaName` | `string` | - -#### Implementation of - -[CustomError](../interfaces/CustomError.md).[payload](../interfaces/CustomError.md#payload) - -#### Defined in - -[sdk/src/types/errors.ts:130](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/errors.ts#L130) - ---- - -### stack - -• `Optional` **stack**: `string` - -#### Inherited from - -Error.stack - -#### Defined in - -node_modules/.pnpm/typescript@5.3.2/node_modules/typescript/lib/lib.es5.d.ts:1077 - ---- - -### prepareStackTrace - -▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` - -#### Type declaration - -▸ (`err`, `stackTraces`): `any` - -Optional override for formatting stack traces - -##### Parameters - -| Name | Type | -| :------------ | :----------- | -| `err` | `Error` | -| `stackTraces` | `CallSite`[] | - -##### Returns - -`any` - -**`See`** - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - -#### Inherited from - -Error.prepareStackTrace - -#### Defined in - -node_modules/.pnpm/@types+node@18.18.7/node_modules/@types/node/globals.d.ts:11 - ---- - -### stackTraceLimit - -▪ `Static` **stackTraceLimit**: `number` - -#### Inherited from - -Error.stackTraceLimit - -#### Defined in - -node_modules/.pnpm/@types+node@18.18.7/node_modules/@types/node/globals.d.ts:13 - -## Methods - -### captureStackTrace - -▸ **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` - -Create .stack property on a target object - -#### Parameters - -| Name | Type | -| :---------------- | :--------- | -| `targetObject` | `object` | -| `constructorOpt?` | `Function` | - -#### Returns - -`void` - -#### Inherited from - -Error.captureStackTrace - -#### Defined in - -node_modules/.pnpm/@types+node@18.18.7/node_modules/@types/node/globals.d.ts:4 diff --git a/docs/docs/developer/api/sdk/classes/UnsupportedChainError.md b/docs/docs/developer/api/sdk/classes/UnsupportedChainError.md deleted file mode 100644 index 789bf68c..00000000 --- a/docs/docs/developer/api/sdk/classes/UnsupportedChainError.md +++ /dev/null @@ -1,202 +0,0 @@ ---- -id: "UnsupportedChainError" -title: "Class: UnsupportedChainError" -sidebar_label: "UnsupportedChainError" -sidebar_position: 0 -custom_edit_url: null ---- - -This blockchain is not yet supported -Please file an issue - -## Hierarchy - -- `Error` - - ↳ **`UnsupportedChainError`** - -## Implements - -- [`CustomError`](../interfaces/CustomError.md) - -## Constructors - -### constructor - -• **new UnsupportedChainError**(`message`, `payload?`): [`UnsupportedChainError`](UnsupportedChainError.md) - -Creates a new instance of the UnsupportedChainError class. - -#### Parameters - -| Name | Type | Description | -| :---------------- | :---------------------------------- | :------------------------ | -| `message` | `string` | The error message. | -| `payload?` | `Object` | Additional error payload. | -| `payload.chainID` | `undefined` \| `string` \| `number` | - | - -#### Returns - -[`UnsupportedChainError`](UnsupportedChainError.md) - -#### Overrides - -Error.constructor - -#### Defined in - -[sdk/src/types/errors.ts:174](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/errors.ts#L174) - -## Properties - -### cause - -• `Optional` **cause**: `unknown` - -#### Inherited from - -Error.cause - -#### Defined in - -node_modules/.pnpm/typescript@5.3.2/node_modules/typescript/lib/lib.es2022.error.d.ts:24 - ---- - -### message - -• **message**: `string` - -#### Inherited from - -Error.message - -#### Defined in - -node_modules/.pnpm/typescript@5.3.2/node_modules/typescript/lib/lib.es5.d.ts:1076 - ---- - -### name - -• **name**: `string` - -#### Inherited from - -Error.name - -#### Defined in - -node_modules/.pnpm/typescript@5.3.2/node_modules/typescript/lib/lib.es5.d.ts:1075 - ---- - -### payload - -• `Optional` **payload**: `Object` - -Additional error payload. - -#### Type declaration - -| Name | Type | -| :-------- | :---------------------------------- | -| `chainID` | `undefined` \| `string` \| `number` | - -#### Implementation of - -[CustomError](../interfaces/CustomError.md).[payload](../interfaces/CustomError.md#payload) - -#### Defined in - -[sdk/src/types/errors.ts:167](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/errors.ts#L167) - ---- - -### stack - -• `Optional` **stack**: `string` - -#### Inherited from - -Error.stack - -#### Defined in - -node_modules/.pnpm/typescript@5.3.2/node_modules/typescript/lib/lib.es5.d.ts:1077 - ---- - -### prepareStackTrace - -▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` - -#### Type declaration - -▸ (`err`, `stackTraces`): `any` - -Optional override for formatting stack traces - -##### Parameters - -| Name | Type | -| :------------ | :----------- | -| `err` | `Error` | -| `stackTraces` | `CallSite`[] | - -##### Returns - -`any` - -**`See`** - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - -#### Inherited from - -Error.prepareStackTrace - -#### Defined in - -node_modules/.pnpm/@types+node@18.18.7/node_modules/@types/node/globals.d.ts:11 - ---- - -### stackTraceLimit - -▪ `Static` **stackTraceLimit**: `number` - -#### Inherited from - -Error.stackTraceLimit - -#### Defined in - -node_modules/.pnpm/@types+node@18.18.7/node_modules/@types/node/globals.d.ts:13 - -## Methods - -### captureStackTrace - -▸ **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` - -Create .stack property on a target object - -#### Parameters - -| Name | Type | -| :---------------- | :--------- | -| `targetObject` | `object` | -| `constructorOpt?` | `Function` | - -#### Returns - -`void` - -#### Inherited from - -Error.captureStackTrace - -#### Defined in - -node_modules/.pnpm/@types+node@18.18.7/node_modules/@types/node/globals.d.ts:4 diff --git a/docs/docs/developer/api/sdk/classes/_category_.yml b/docs/docs/developer/api/sdk/classes/_category_.yml deleted file mode 100644 index 55c7980a..00000000 --- a/docs/docs/developer/api/sdk/classes/_category_.yml +++ /dev/null @@ -1,2 +0,0 @@ -label: "Classes" -position: 3 \ No newline at end of file diff --git a/docs/docs/developer/api/sdk/index.md b/docs/docs/developer/api/sdk/index.md deleted file mode 100644 index 6e5c33b0..00000000 --- a/docs/docs/developer/api/sdk/index.md +++ /dev/null @@ -1,141 +0,0 @@ ---- -id: "index" -title: "@hypercerts-org/sdk" -sidebar_label: "Readme" -sidebar_position: 0 -custom_edit_url: null ---- - -# Hypercert SDK - -## Quickstart Guide - -1. Install the SDK using npm or yarn: - -```bash -npm install @hypercerts-org/sdk -``` - -or - -```bash - yarn add @hypercerts-org/sdk -``` - -2. Import the SDK into your project: - -```bash -import { HypercertClient } from "@hypercerts-org/sdk"; -``` - -3. Create a new instance of the HypercertClient class with your configuration options: - -```js -const client = new HypercertClient({ - chain: { id: 11155111 }, // required -}); -``` - -> **Note** If there's no `walletClient` provided the client will run in [read-only mode](#read-only-mode) - -4. Use the client object to interact with the Hypercert network. - -For example, you can use the `client.mintClaim` method to create a new claim: - -```js -const tx = await client.mintClaim( - metaData, - totalUnits, - transferRestriction, - overrides, -); -``` - -This will validate the metadata, store it on IPFS, create a new hypercert on-chain and return a transaction receipt. - -You can also use the client to query the subgraph and retrieve which claims an address owns: - -```js -const claims = await client.indexer.fractionsByOwner(owner); -``` - -For more information on how to use the SDK, check out the -[developer documentation](https://hypercerts.org/docs/developer/) and the -[Graph playground](https://thegraph.com/hosted-service/subgraph/hypercerts-admin/hypercerts-testnet). - -That's it! With these simple steps, you can start using the Hypercert SDK in your own projects. - -## Config - -HypercertClientConfig is a configuration object used when initializing a new instance of the HypercertClient. It allows -you to customize the client by setting your own providers or deployments. At it's simplest, you only need to provide -`chain.id` to initalize the client in `readonly` mode. - -| Field | Type | Description | -| --------------------------- | --------------------------------- | ---------------------------------------------------------------------------------------------- | ------------------------------- | -| `chain` | Object | Partial configuration for the blockchain network. | -| `contractAddress` | String | The address of the deployed contract. | -| `graphName` | String | The name of the subgraph. | -| `easContractAddress` | String | The address of the EAS contract. | -| `publicClient` | Object | The PublicClient is inherently read-only and is used for reading data from the blockchain. | -| `walletClient` | Object | The WalletClient is used for signing and sending transactions. | -| `unsafeForceOverrideConfig` | Boolean | Boolean to force the use of overridden values. | -| `readOnly` | Boolean | Boolean to assert if the client is in read-only mode. | -| `readOnlyReason` | String | Reason for read-only mode. This is optional and can be used for logging or debugging purposes. | -| `indexerEnvironment` | `'test' \| 'production' \| 'all'` | Determines which graphs should be read out when querying | The environment of the indexer. | - -### Read-only mode - -The SDK client will be in read-only mode if any of the following conditions are true: - -- The client was initialized without a walletprovider. -- The contract address is not set. -- The storage layer is in read-only mode. - -If any of these conditions are true, the readonly property of the HypercertClient instance will be set to true, and a -warning message will be logged indicating that the client is in read-only mode. - -### Logging - -The logger for the SDK uses the log level based on the value of the LOG_LEVEL environment variable. The log level -determines which log messages are printed to the console. By default, the logger is configured to log messages with a -level of info or higher to the console. - -## Client modules - -The `HypercertClient` provides a high-level interface for interacting with the Hypercert ecosystem. The HypercertClient -has three getter methods: `storage`, `indexer`, and `contract`. These methods return instances of the HypercertsStorage, -HypercertIndexer, and HypercertMinter classes, respectively. - -```js -const { - client: { storage }, -} = new HypercertClient({ chain: { id: 11155111 } }); -``` - -The `storage` is a utility class that provides methods for storing and retrieving Hypercert metadata from IPFS. It is -used by the HypercertClient to store metadata when creating new Hypercerts. - -```js -const { - client: { indexer }, -} = new HypercertClient({ chain: { id: 11155111 } }); -``` - -The `indexer` is a utility class that provides methods for indexing and searching Hypercerts based on various criteria. -It is used by the HypercertClient to retrieve event-based data via the subgraph - -```js -const { - client: { contract }, -} = new HypercertClient({ chain: { id: 11155111 } }); -``` - -Finally we have a `contract` that provides methods for interacting with the HypercertMinter smart contract. It is used -by the HypercertClient to create new Hypercerts and retrieve specific on-chain information. - -By providing instances of these classes through the storage, indexer, and contract getters, the HypercertClient allows -developers to easily interact with the various components of the Hypercert system. For example, a developer could use -the storage instance to store metadata for a new Hypercert, the indexer instance to search for existing Hypercerts based -on various criteria, and the contract instance to create new Hypercerts and retrieve existing Hypercerts from the -contract. diff --git a/docs/docs/developer/api/sdk/interfaces/CustomError.md b/docs/docs/developer/api/sdk/interfaces/CustomError.md deleted file mode 100644 index 392d17e9..00000000 --- a/docs/docs/developer/api/sdk/interfaces/CustomError.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -id: "CustomError" -title: "Interface: CustomError" -sidebar_label: "CustomError" -sidebar_position: 0 -custom_edit_url: null ---- - -An interface for errors that have a specific type. - -## Implemented by - -- [`ClientError`](../classes/ClientError.md) -- [`ConfigurationError`](../classes/ConfigurationError.md) -- [`ContractError`](../classes/ContractError.md) -- [`FetchError`](../classes/FetchError.md) -- [`InvalidOrMissingError`](../classes/InvalidOrMissingError.md) -- [`MalformedDataError`](../classes/MalformedDataError.md) -- [`MintingError`](../classes/MintingError.md) -- [`StorageError`](../classes/StorageError.md) -- [`UnknownSchemaError`](../classes/UnknownSchemaError.md) -- [`UnsupportedChainError`](../classes/UnsupportedChainError.md) - -## Properties - -### payload - -• `Optional` **payload**: `Object` - -Additional error payload. - -#### Index signature - -▪ [key: `string`]: `unknown` - -#### Defined in - -[sdk/src/types/errors.ts:10](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/errors.ts#L10) diff --git a/docs/docs/developer/api/sdk/interfaces/DuplicateEvaluation.md b/docs/docs/developer/api/sdk/interfaces/DuplicateEvaluation.md deleted file mode 100644 index b2d63435..00000000 --- a/docs/docs/developer/api/sdk/interfaces/DuplicateEvaluation.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -id: "DuplicateEvaluation" -title: "Interface: DuplicateEvaluation" -sidebar_label: "DuplicateEvaluation" -sidebar_position: 0 -custom_edit_url: null ---- - -## Indexable - -▪ [k: `string`]: `unknown` - -## Properties - -### duplicateHypercerts - -• **duplicateHypercerts**: [`HypercertPointer`](HypercertPointer.md)[] - -#### Defined in - -[sdk/src/types/evaluation.d.ts:22](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/evaluation.d.ts#L22) - ---- - -### explanation - -• **explanation**: `string` - -#### Defined in - -[sdk/src/types/evaluation.d.ts:24](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/evaluation.d.ts#L24) - ---- - -### realHypercert - -• **realHypercert**: [`HypercertPointer`](HypercertPointer.md) - -#### Defined in - -[sdk/src/types/evaluation.d.ts:23](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/evaluation.d.ts#L23) - ---- - -### type - -• **type**: `"duplicate"` - -#### Defined in - -[sdk/src/types/evaluation.d.ts:21](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/evaluation.d.ts#L21) diff --git a/docs/docs/developer/api/sdk/interfaces/EASEvaluation.md b/docs/docs/developer/api/sdk/interfaces/EASEvaluation.md deleted file mode 100644 index a68f6cce..00000000 --- a/docs/docs/developer/api/sdk/interfaces/EASEvaluation.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -id: "EASEvaluation" -title: "Interface: EASEvaluation" -sidebar_label: "EASEvaluation" -sidebar_position: 0 -custom_edit_url: null ---- - -## Indexable - -▪ [k: `string`]: `unknown` - -## Properties - -### chainId - -• **chainId**: `string` - -#### Defined in - -[sdk/src/types/evaluation.d.ts:41](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/evaluation.d.ts#L41) - ---- - -### contract - -• **contract**: `string` - -#### Defined in - -[sdk/src/types/evaluation.d.ts:42](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/evaluation.d.ts#L42) - ---- - -### type - -• **type**: `"EAS"` - -#### Defined in - -[sdk/src/types/evaluation.d.ts:40](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/evaluation.d.ts#L40) - ---- - -### uid - -• **uid**: `string` - -#### Defined in - -[sdk/src/types/evaluation.d.ts:43](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/evaluation.d.ts#L43) diff --git a/docs/docs/developer/api/sdk/interfaces/HypercertClaimdata.md b/docs/docs/developer/api/sdk/interfaces/HypercertClaimdata.md deleted file mode 100644 index c309d77d..00000000 --- a/docs/docs/developer/api/sdk/interfaces/HypercertClaimdata.md +++ /dev/null @@ -1,160 +0,0 @@ ---- -id: "HypercertClaimdata" -title: "Interface: HypercertClaimdata" -sidebar_label: "HypercertClaimdata" -sidebar_position: 0 -custom_edit_url: null ---- - -Properties of an impact claim - -## Indexable - -▪ [k: `string`]: `unknown` - -## Properties - -### contributors - -• **contributors**: `Object` - -Contributors - -#### Index signature - -▪ [k: `string`]: `unknown` - -#### Type declaration - -| Name | Type | -| :--------------- | :--------- | -| `display_value?` | `string` | -| `name?` | `string` | -| `value?` | `string`[] | - -#### Defined in - -[sdk/src/types/claimdata.d.ts:53](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/claimdata.d.ts#L53) - ---- - -### impact_scope - -• **impact_scope**: `Object` - -Scopes of impact - -#### Index signature - -▪ [k: `string`]: `unknown` - -#### Type declaration - -| Name | Type | -| :--------------- | :--------- | -| `display_value?` | `string` | -| `excludes?` | `string`[] | -| `name?` | `string` | -| `value?` | `string`[] | - -#### Defined in - -[sdk/src/types/claimdata.d.ts:15](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/claimdata.d.ts#L15) - ---- - -### impact_timeframe - -• **impact_timeframe**: `Object` - -Impact time period. The value is UNIX time in seconds from epoch. - -#### Index signature - -▪ [k: `string`]: `unknown` - -#### Type declaration - -| Name | Type | -| :--------------- | :--------- | -| `display_value?` | `string` | -| `name?` | `string` | -| `value?` | `number`[] | - -#### Defined in - -[sdk/src/types/claimdata.d.ts:44](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/claimdata.d.ts#L44) - ---- - -### rights - -• `Optional` **rights**: `Object` - -Rights - -#### Index signature - -▪ [k: `string`]: `unknown` - -#### Type declaration - -| Name | Type | -| :--------------- | :--------- | -| `display_value?` | `string` | -| `excludes?` | `string`[] | -| `name?` | `string` | -| `value?` | `string`[] | - -#### Defined in - -[sdk/src/types/claimdata.d.ts:62](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/claimdata.d.ts#L62) - ---- - -### work_scope - -• **work_scope**: `Object` - -Scopes of work - -#### Index signature - -▪ [k: `string`]: `unknown` - -#### Type declaration - -| Name | Type | -| :--------------- | :--------- | -| `display_value?` | `string` | -| `excludes?` | `string`[] | -| `name?` | `string` | -| `value?` | `string`[] | - -#### Defined in - -[sdk/src/types/claimdata.d.ts:25](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/claimdata.d.ts#L25) - ---- - -### work_timeframe - -• **work_timeframe**: `Object` - -Work time period. The value is UNIX time in seconds from epoch. - -#### Index signature - -▪ [k: `string`]: `unknown` - -#### Type declaration - -| Name | Type | -| :--------------- | :--------- | -| `display_value?` | `string` | -| `name?` | `string` | -| `value?` | `number`[] | - -#### Defined in - -[sdk/src/types/claimdata.d.ts:35](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/claimdata.d.ts#L35) diff --git a/docs/docs/developer/api/sdk/interfaces/HypercertClientInterface.md b/docs/docs/developer/api/sdk/interfaces/HypercertClientInterface.md deleted file mode 100644 index 2045e99e..00000000 --- a/docs/docs/developer/api/sdk/interfaces/HypercertClientInterface.md +++ /dev/null @@ -1,476 +0,0 @@ ---- -id: "HypercertClientInterface" -title: "Interface: HypercertClientInterface" -sidebar_label: "HypercertClientInterface" -sidebar_position: 0 -custom_edit_url: null ---- - -The interface for the Hypercert client. - -## Hierarchy - -- [`HypercertClientMethods`](HypercertClientMethods.md) - -- [`HypercertClientState`](HypercertClientState.md) - - ↳ **`HypercertClientInterface`** - -## Implemented by - -- [`HypercertClient`](../classes/HypercertClient.md) - -## Properties - -### batchMintClaimFractionsFromAllowlists - -• **batchMintClaimFractionsFromAllowlists**: (`claimIds`: `bigint`[], `units`: `bigint`[], `proofs`: (\`0x$\{string}\` \| `Uint8Array`)[][]) => `Promise`<`undefined` \| \`0x$\{string}\`\> - -#### Type declaration - -▸ (`claimIds`, `units`, `proofs`): `Promise`<`undefined` \| \`0x$\{string}\`\> - -Batch mints a claim fraction from an allowlist - -##### Parameters - -| Name | Type | Description | -| :--------- | :------------------------------------- | :---------------------------------------------------- | -| `claimIds` | `bigint`[] | Array of the IDs of the claims to mint fractions for. | -| `units` | `bigint`[] | Array of the number of units for each fraction. | -| `proofs` | (\`0x$\{string}\` \| `Uint8Array`)[][] | Array of Merkle proofs for the allowlists. | - -##### Returns - -`Promise`<`undefined` \| \`0x$\{string}\`\> - -A Promise that resolves to the transaction receipt - -A Promise that resolves to the transaction hash - -**`Note`** - -The length of the arrays must be equal. - -**`Note`** - -The order of the arrays must be equal. - -#### Inherited from - -[HypercertClientMethods](HypercertClientMethods.md).[batchMintClaimFractionsFromAllowlists](HypercertClientMethods.md#batchmintclaimfractionsfromallowlists) - -#### Defined in - -[sdk/src/types/client.ts:291](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/client.ts#L291) - ---- - -### batchTransferFractions - -• **batchTransferFractions**: (`fractionIds`: `bigint`[], `to`: \`0x$\{string}\`, `overrides?`: [`SupportedOverrides`](../modules.md#supportedoverrides)) => `Promise`<`undefined` \| \`0x$\{string}\`\> - -#### Type declaration - -▸ (`fractionIds`, `to`, `overrides?`): `Promise`<`undefined` \| \`0x$\{string}\`\> - -Transfers multiple claim fractions to a new owner. - -##### Parameters - -| Name | Type | -| :------------ | :------------------------------------------------------- | -| `fractionIds` | `bigint`[] | -| `to` | \`0x$\{string}\` | -| `overrides?` | [`SupportedOverrides`](../modules.md#supportedoverrides) | - -##### Returns - -`Promise`<`undefined` \| \`0x$\{string}\`\> - -A Promise that resolves to the transaction hash - -#### Inherited from - -[HypercertClientMethods](HypercertClientMethods.md).[batchTransferFractions](HypercertClientMethods.md#batchtransferfractions) - -#### Defined in - -[sdk/src/types/client.ts:225](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/client.ts#L225) - ---- - -### burnClaimFraction - -• **burnClaimFraction**: (`fractionId`: `bigint`) => `Promise`<`undefined` \| \`0x$\{string}\`\> - -#### Type declaration - -▸ (`fractionId`): `Promise`<`undefined` \| \`0x$\{string}\`\> - -Burns a claim fraction. - -##### Parameters - -| Name | Type | Description | -| :----------- | :------- | :------------------------------------ | -| `fractionId` | `bigint` | The ID of the claim fraction to burn. | - -##### Returns - -`Promise`<`undefined` \| \`0x$\{string}\`\> - -A Promise that resolves to the transaction hash - -#### Inherited from - -[HypercertClientMethods](HypercertClientMethods.md).[burnClaimFraction](HypercertClientMethods.md#burnclaimfraction) - -#### Defined in - -[sdk/src/types/client.ts:266](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/client.ts#L266) - ---- - -### createAllowlist - -• **createAllowlist**: (`allowList`: [`AllowlistEntry`](../modules.md#allowlistentry)[], `metaData`: [`HypercertMetadata`](HypercertMetadata.md), `totalUnits`: `bigint`, `transferRestriction`: [`TransferRestrictions`](../modules.md#transferrestrictions-1)) => `Promise`<`undefined` \| \`0x$\{string}\`\> - -#### Type declaration - -▸ (`allowList`, `metaData`, `totalUnits`, `transferRestriction`): `Promise`<`undefined` \| \`0x$\{string}\`\> - -Creates a new allowlist and mints a new claim with the allowlist. - -##### Parameters - -| Name | Type | Description | -| :-------------------- | :------------------------------------------------------------- | :--------------------------------------- | -| `allowList` | [`AllowlistEntry`](../modules.md#allowlistentry)[] | The allowlist for the claim. | -| `metaData` | [`HypercertMetadata`](HypercertMetadata.md) | The metadata for the claim. | -| `totalUnits` | `bigint` | The total number of units for the claim. | -| `transferRestriction` | [`TransferRestrictions`](../modules.md#transferrestrictions-1) | The transfer restriction for the claim. | - -##### Returns - -`Promise`<`undefined` \| \`0x$\{string}\`\> - -A Promise that resolves to the transaction hash - -#### Inherited from - -[HypercertClientMethods](HypercertClientMethods.md).[createAllowlist](HypercertClientMethods.md#createallowlist) - -#### Defined in - -[sdk/src/types/client.ts:239](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/client.ts#L239) - ---- - -### getDeployments - -• **getDeployments**: (`chainId`: [`SupportedChainIds`](../modules.md#supportedchainids)) => `Partial`<[`Deployment`](../modules.md#deployment)\> - -#### Type declaration - -▸ (`chainId`): `Partial`<[`Deployment`](../modules.md#deployment)\> - -Gets the contract addresses and graph urls for the provided `chainId` - -##### Parameters - -| Name | Type | -| :-------- | :----------------------------------------------------- | -| `chainId` | [`SupportedChainIds`](../modules.md#supportedchainids) | - -##### Returns - -`Partial`<[`Deployment`](../modules.md#deployment)\> - -The addresses, graph name and graph url. - -#### Inherited from - -[HypercertClientMethods](HypercertClientMethods.md).[getDeployments](HypercertClientMethods.md#getdeployments) - -#### Defined in - -[sdk/src/types/client.ts:183](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/client.ts#L183) - ---- - -### getTransferRestrictions - -• **getTransferRestrictions**: (`fractionId`: `bigint`) => `Promise`<[`TransferRestrictions`](../modules.md#transferrestrictions-1)\> - -#### Type declaration - -▸ (`fractionId`): `Promise`<[`TransferRestrictions`](../modules.md#transferrestrictions-1)\> - -Retrieves the TransferRestrictions for a claim. - -##### Parameters - -| Name | Type | Description | -| :----------- | :------- | :------------------------------- | -| `fractionId` | `bigint` | The ID of the claim to retrieve. | - -##### Returns - -`Promise`<[`TransferRestrictions`](../modules.md#transferrestrictions-1)\> - -A Promise that resolves to the applicable transfer restrictions. - -#### Inherited from - -[HypercertClientMethods](HypercertClientMethods.md).[getTransferRestrictions](HypercertClientMethods.md#gettransferrestrictions) - -#### Defined in - -[sdk/src/types/client.ts:203](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/client.ts#L203) - ---- - -### indexer - -• **indexer**: `HypercertIndexer` - -The indexer used by the client. - -#### Inherited from - -[HypercertClientState](HypercertClientState.md).[indexer](HypercertClientState.md#indexer) - -#### Defined in - -[sdk/src/types/client.ts:172](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/client.ts#L172) - ---- - -### isClaimOrFractionOnConnectedChain - -• **isClaimOrFractionOnConnectedChain**: (`claimOrFractionId`: `string`) => `boolean` - -#### Type declaration - -▸ (`claimOrFractionId`): `boolean` - -Check if a claim or fraction is on the chain that the Hypercertclient -is currently connected to - -##### Parameters - -| Name | Type | Description | -| :------------------ | :------- | :---------------------------------------- | -| `claimOrFractionId` | `string` | The ID of the claim or fraction to check. | - -##### Returns - -`boolean` - -#### Inherited from - -[HypercertClientMethods](HypercertClientMethods.md).[isClaimOrFractionOnConnectedChain](HypercertClientMethods.md#isclaimorfractiononconnectedchain) - -#### Defined in - -[sdk/src/types/client.ts:302](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/client.ts#L302) - ---- - -### mergeFractionUnits - -• **mergeFractionUnits**: (`fractionIds`: `bigint`[]) => `Promise`<`undefined` \| \`0x$\{string}\`\> - -#### Type declaration - -▸ (`fractionIds`): `Promise`<`undefined` \| \`0x$\{string}\`\> - -Merges multiple claim fractions into a single claim. - -##### Parameters - -| Name | Type | Description | -| :------------ | :--------- | :--------------------------------------- | -| `fractionIds` | `bigint`[] | The IDs of the claim fractions to merge. | - -##### Returns - -`Promise`<`undefined` \| \`0x$\{string}\`\> - -A Promise that resolves to the transaction hash - -#### Inherited from - -[HypercertClientMethods](HypercertClientMethods.md).[mergeFractionUnits](HypercertClientMethods.md#mergefractionunits) - -#### Defined in - -[sdk/src/types/client.ts:259](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/client.ts#L259) - ---- - -### mintClaim - -• **mintClaim**: (`metaData`: [`HypercertMetadata`](HypercertMetadata.md), `totalUnits`: `bigint`, `transferRestriction`: [`TransferRestrictions`](../modules.md#transferrestrictions-1)) => `Promise`<`undefined` \| \`0x$\{string}\`\> - -#### Type declaration - -▸ (`metaData`, `totalUnits`, `transferRestriction`): `Promise`<`undefined` \| \`0x$\{string}\`\> - -Mints a new claim. - -##### Parameters - -| Name | Type | Description | -| :-------------------- | :------------------------------------------------------------- | :--------------------------------------- | -| `metaData` | [`HypercertMetadata`](HypercertMetadata.md) | The metadata for the claim. | -| `totalUnits` | `bigint` | The total number of units for the claim. | -| `transferRestriction` | [`TransferRestrictions`](../modules.md#transferrestrictions-1) | The transfer restriction for the claim. | - -##### Returns - -`Promise`<`undefined` \| \`0x$\{string}\`\> - -A Promise that resolves to the transaction hash - -#### Inherited from - -[HypercertClientMethods](HypercertClientMethods.md).[mintClaim](HypercertClientMethods.md#mintclaim) - -#### Defined in - -[sdk/src/types/client.ts:192](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/client.ts#L192) - ---- - -### mintClaimFractionFromAllowlist - -• **mintClaimFractionFromAllowlist**: (`claimId`: `bigint`, `units`: `bigint`, `proof`: (\`0x$\{string}\` \| `Uint8Array`)[]) => `Promise`<`undefined` \| \`0x$\{string}\`\> - -#### Type declaration - -▸ (`claimId`, `units`, `proof`): `Promise`<`undefined` \| \`0x$\{string}\`\> - -Mints a claim fraction from an allowlist. - -##### Parameters - -| Name | Type | Description | -| :-------- | :----------------------------------- | :------------------------------------------ | -| `claimId` | `bigint` | The ID of the claim to mint a fraction for. | -| `units` | `bigint` | The number of units for the fraction. | -| `proof` | (\`0x$\{string}\` \| `Uint8Array`)[] | The Merkle proof for the allowlist. | - -##### Returns - -`Promise`<`undefined` \| \`0x$\{string}\`\> - -A Promise that resolves to the transaction hash - -#### Inherited from - -[HypercertClientMethods](HypercertClientMethods.md).[mintClaimFractionFromAllowlist](HypercertClientMethods.md#mintclaimfractionfromallowlist) - -#### Defined in - -[sdk/src/types/client.ts:275](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/client.ts#L275) - ---- - -### readonly - -• **readonly**: `boolean` - -Whether the client is in read-only mode. - -#### Inherited from - -[HypercertClientState](HypercertClientState.md).[readonly](HypercertClientState.md#readonly) - -#### Defined in - -[sdk/src/types/client.ts:168](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/client.ts#L168) - ---- - -### splitFractionUnits - -• **splitFractionUnits**: (`fractionId`: `bigint`, `fractions`: `bigint`[]) => `Promise`<`undefined` \| \`0x$\{string}\`\> - -#### Type declaration - -▸ (`fractionId`, `fractions`): `Promise`<`undefined` \| \`0x$\{string}\`\> - -Splits a claim into multiple fractions. - -##### Parameters - -| Name | Type | Description | -| :----------- | :--------- | :---------------------------- | -| `fractionId` | `bigint` | The ID of the claim to split. | -| `fractions` | `bigint`[] | - | - -##### Returns - -`Promise`<`undefined` \| \`0x$\{string}\`\> - -A Promise that resolves to the transaction hash - -#### Inherited from - -[HypercertClientMethods](HypercertClientMethods.md).[splitFractionUnits](HypercertClientMethods.md#splitfractionunits) - -#### Defined in - -[sdk/src/types/client.ts:252](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/client.ts#L252) - ---- - -### storage - -• **storage**: [`HypercertStorageInterface`](HypercertStorageInterface.md) - -The storage layer used by the client. - -#### Inherited from - -[HypercertClientState](HypercertClientState.md).[storage](HypercertClientState.md#storage) - -#### Defined in - -[sdk/src/types/client.ts:170](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/client.ts#L170) - ---- - -### transferFraction - -• **transferFraction**: (`fractionId`: `bigint`, `to`: \`0x$\{string}\`, `overrides?`: [`SupportedOverrides`](../modules.md#supportedoverrides)) => `Promise`<`undefined` \| \`0x$\{string}\`\> - -#### Type declaration - -▸ (`fractionId`, `to`, `overrides?`): `Promise`<`undefined` \| \`0x$\{string}\`\> - -Transfers a claim fraction to a new owner. - -##### Parameters - -| Name | Type | -| :----------- | :------------------------------------------------------- | -| `fractionId` | `bigint` | -| `to` | \`0x$\{string}\` | -| `overrides?` | [`SupportedOverrides`](../modules.md#supportedoverrides) | - -##### Returns - -`Promise`<`undefined` \| \`0x$\{string}\`\> - -A Promise that resolves to the transaction hash - -#### Inherited from - -[HypercertClientMethods](HypercertClientMethods.md).[transferFraction](HypercertClientMethods.md#transferfraction) - -#### Defined in - -[sdk/src/types/client.ts:212](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/client.ts#L212) diff --git a/docs/docs/developer/api/sdk/interfaces/HypercertClientMethods.md b/docs/docs/developer/api/sdk/interfaces/HypercertClientMethods.md deleted file mode 100644 index be54b2af..00000000 --- a/docs/docs/developer/api/sdk/interfaces/HypercertClientMethods.md +++ /dev/null @@ -1,374 +0,0 @@ ---- -id: "HypercertClientMethods" -title: "Interface: HypercertClientMethods" -sidebar_label: "HypercertClientMethods" -sidebar_position: 0 -custom_edit_url: null ---- - -The methods for the Hypercert client. - -## Hierarchy - -- **`HypercertClientMethods`** - - ↳ [`HypercertClientInterface`](HypercertClientInterface.md) - -## Properties - -### batchMintClaimFractionsFromAllowlists - -• **batchMintClaimFractionsFromAllowlists**: (`claimIds`: `bigint`[], `units`: `bigint`[], `proofs`: (\`0x$\{string}\` \| `Uint8Array`)[][]) => `Promise`<`undefined` \| \`0x$\{string}\`\> - -#### Type declaration - -▸ (`claimIds`, `units`, `proofs`): `Promise`<`undefined` \| \`0x$\{string}\`\> - -Batch mints a claim fraction from an allowlist - -##### Parameters - -| Name | Type | Description | -| :--------- | :------------------------------------- | :---------------------------------------------------- | -| `claimIds` | `bigint`[] | Array of the IDs of the claims to mint fractions for. | -| `units` | `bigint`[] | Array of the number of units for each fraction. | -| `proofs` | (\`0x$\{string}\` \| `Uint8Array`)[][] | Array of Merkle proofs for the allowlists. | - -##### Returns - -`Promise`<`undefined` \| \`0x$\{string}\`\> - -A Promise that resolves to the transaction receipt - -A Promise that resolves to the transaction hash - -**`Note`** - -The length of the arrays must be equal. - -**`Note`** - -The order of the arrays must be equal. - -#### Defined in - -[sdk/src/types/client.ts:291](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/client.ts#L291) - ---- - -### batchTransferFractions - -• **batchTransferFractions**: (`fractionIds`: `bigint`[], `to`: \`0x$\{string}\`, `overrides?`: [`SupportedOverrides`](../modules.md#supportedoverrides)) => `Promise`<`undefined` \| \`0x$\{string}\`\> - -#### Type declaration - -▸ (`fractionIds`, `to`, `overrides?`): `Promise`<`undefined` \| \`0x$\{string}\`\> - -Transfers multiple claim fractions to a new owner. - -##### Parameters - -| Name | Type | -| :------------ | :------------------------------------------------------- | -| `fractionIds` | `bigint`[] | -| `to` | \`0x$\{string}\` | -| `overrides?` | [`SupportedOverrides`](../modules.md#supportedoverrides) | - -##### Returns - -`Promise`<`undefined` \| \`0x$\{string}\`\> - -A Promise that resolves to the transaction hash - -#### Defined in - -[sdk/src/types/client.ts:225](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/client.ts#L225) - ---- - -### burnClaimFraction - -• **burnClaimFraction**: (`fractionId`: `bigint`) => `Promise`<`undefined` \| \`0x$\{string}\`\> - -#### Type declaration - -▸ (`fractionId`): `Promise`<`undefined` \| \`0x$\{string}\`\> - -Burns a claim fraction. - -##### Parameters - -| Name | Type | Description | -| :----------- | :------- | :------------------------------------ | -| `fractionId` | `bigint` | The ID of the claim fraction to burn. | - -##### Returns - -`Promise`<`undefined` \| \`0x$\{string}\`\> - -A Promise that resolves to the transaction hash - -#### Defined in - -[sdk/src/types/client.ts:266](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/client.ts#L266) - ---- - -### createAllowlist - -• **createAllowlist**: (`allowList`: [`AllowlistEntry`](../modules.md#allowlistentry)[], `metaData`: [`HypercertMetadata`](HypercertMetadata.md), `totalUnits`: `bigint`, `transferRestriction`: [`TransferRestrictions`](../modules.md#transferrestrictions-1)) => `Promise`<`undefined` \| \`0x$\{string}\`\> - -#### Type declaration - -▸ (`allowList`, `metaData`, `totalUnits`, `transferRestriction`): `Promise`<`undefined` \| \`0x$\{string}\`\> - -Creates a new allowlist and mints a new claim with the allowlist. - -##### Parameters - -| Name | Type | Description | -| :-------------------- | :------------------------------------------------------------- | :--------------------------------------- | -| `allowList` | [`AllowlistEntry`](../modules.md#allowlistentry)[] | The allowlist for the claim. | -| `metaData` | [`HypercertMetadata`](HypercertMetadata.md) | The metadata for the claim. | -| `totalUnits` | `bigint` | The total number of units for the claim. | -| `transferRestriction` | [`TransferRestrictions`](../modules.md#transferrestrictions-1) | The transfer restriction for the claim. | - -##### Returns - -`Promise`<`undefined` \| \`0x$\{string}\`\> - -A Promise that resolves to the transaction hash - -#### Defined in - -[sdk/src/types/client.ts:239](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/client.ts#L239) - ---- - -### getDeployments - -• **getDeployments**: (`chainId`: [`SupportedChainIds`](../modules.md#supportedchainids)) => `Partial`<[`Deployment`](../modules.md#deployment)\> - -#### Type declaration - -▸ (`chainId`): `Partial`<[`Deployment`](../modules.md#deployment)\> - -Gets the contract addresses and graph urls for the provided `chainId` - -##### Parameters - -| Name | Type | -| :-------- | :----------------------------------------------------- | -| `chainId` | [`SupportedChainIds`](../modules.md#supportedchainids) | - -##### Returns - -`Partial`<[`Deployment`](../modules.md#deployment)\> - -The addresses, graph name and graph url. - -#### Defined in - -[sdk/src/types/client.ts:183](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/client.ts#L183) - ---- - -### getTransferRestrictions - -• **getTransferRestrictions**: (`fractionId`: `bigint`) => `Promise`<[`TransferRestrictions`](../modules.md#transferrestrictions-1)\> - -#### Type declaration - -▸ (`fractionId`): `Promise`<[`TransferRestrictions`](../modules.md#transferrestrictions-1)\> - -Retrieves the TransferRestrictions for a claim. - -##### Parameters - -| Name | Type | Description | -| :----------- | :------- | :------------------------------- | -| `fractionId` | `bigint` | The ID of the claim to retrieve. | - -##### Returns - -`Promise`<[`TransferRestrictions`](../modules.md#transferrestrictions-1)\> - -A Promise that resolves to the applicable transfer restrictions. - -#### Defined in - -[sdk/src/types/client.ts:203](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/client.ts#L203) - ---- - -### isClaimOrFractionOnConnectedChain - -• **isClaimOrFractionOnConnectedChain**: (`claimOrFractionId`: `string`) => `boolean` - -#### Type declaration - -▸ (`claimOrFractionId`): `boolean` - -Check if a claim or fraction is on the chain that the Hypercertclient -is currently connected to - -##### Parameters - -| Name | Type | Description | -| :------------------ | :------- | :---------------------------------------- | -| `claimOrFractionId` | `string` | The ID of the claim or fraction to check. | - -##### Returns - -`boolean` - -#### Defined in - -[sdk/src/types/client.ts:302](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/client.ts#L302) - ---- - -### mergeFractionUnits - -• **mergeFractionUnits**: (`fractionIds`: `bigint`[]) => `Promise`<`undefined` \| \`0x$\{string}\`\> - -#### Type declaration - -▸ (`fractionIds`): `Promise`<`undefined` \| \`0x$\{string}\`\> - -Merges multiple claim fractions into a single claim. - -##### Parameters - -| Name | Type | Description | -| :------------ | :--------- | :--------------------------------------- | -| `fractionIds` | `bigint`[] | The IDs of the claim fractions to merge. | - -##### Returns - -`Promise`<`undefined` \| \`0x$\{string}\`\> - -A Promise that resolves to the transaction hash - -#### Defined in - -[sdk/src/types/client.ts:259](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/client.ts#L259) - ---- - -### mintClaim - -• **mintClaim**: (`metaData`: [`HypercertMetadata`](HypercertMetadata.md), `totalUnits`: `bigint`, `transferRestriction`: [`TransferRestrictions`](../modules.md#transferrestrictions-1)) => `Promise`<`undefined` \| \`0x$\{string}\`\> - -#### Type declaration - -▸ (`metaData`, `totalUnits`, `transferRestriction`): `Promise`<`undefined` \| \`0x$\{string}\`\> - -Mints a new claim. - -##### Parameters - -| Name | Type | Description | -| :-------------------- | :------------------------------------------------------------- | :--------------------------------------- | -| `metaData` | [`HypercertMetadata`](HypercertMetadata.md) | The metadata for the claim. | -| `totalUnits` | `bigint` | The total number of units for the claim. | -| `transferRestriction` | [`TransferRestrictions`](../modules.md#transferrestrictions-1) | The transfer restriction for the claim. | - -##### Returns - -`Promise`<`undefined` \| \`0x$\{string}\`\> - -A Promise that resolves to the transaction hash - -#### Defined in - -[sdk/src/types/client.ts:192](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/client.ts#L192) - ---- - -### mintClaimFractionFromAllowlist - -• **mintClaimFractionFromAllowlist**: (`claimId`: `bigint`, `units`: `bigint`, `proof`: (\`0x$\{string}\` \| `Uint8Array`)[]) => `Promise`<`undefined` \| \`0x$\{string}\`\> - -#### Type declaration - -▸ (`claimId`, `units`, `proof`): `Promise`<`undefined` \| \`0x$\{string}\`\> - -Mints a claim fraction from an allowlist. - -##### Parameters - -| Name | Type | Description | -| :-------- | :----------------------------------- | :------------------------------------------ | -| `claimId` | `bigint` | The ID of the claim to mint a fraction for. | -| `units` | `bigint` | The number of units for the fraction. | -| `proof` | (\`0x$\{string}\` \| `Uint8Array`)[] | The Merkle proof for the allowlist. | - -##### Returns - -`Promise`<`undefined` \| \`0x$\{string}\`\> - -A Promise that resolves to the transaction hash - -#### Defined in - -[sdk/src/types/client.ts:275](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/client.ts#L275) - ---- - -### splitFractionUnits - -• **splitFractionUnits**: (`fractionId`: `bigint`, `fractions`: `bigint`[]) => `Promise`<`undefined` \| \`0x$\{string}\`\> - -#### Type declaration - -▸ (`fractionId`, `fractions`): `Promise`<`undefined` \| \`0x$\{string}\`\> - -Splits a claim into multiple fractions. - -##### Parameters - -| Name | Type | Description | -| :----------- | :--------- | :---------------------------- | -| `fractionId` | `bigint` | The ID of the claim to split. | -| `fractions` | `bigint`[] | - | - -##### Returns - -`Promise`<`undefined` \| \`0x$\{string}\`\> - -A Promise that resolves to the transaction hash - -#### Defined in - -[sdk/src/types/client.ts:252](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/client.ts#L252) - ---- - -### transferFraction - -• **transferFraction**: (`fractionId`: `bigint`, `to`: \`0x$\{string}\`, `overrides?`: [`SupportedOverrides`](../modules.md#supportedoverrides)) => `Promise`<`undefined` \| \`0x$\{string}\`\> - -#### Type declaration - -▸ (`fractionId`, `to`, `overrides?`): `Promise`<`undefined` \| \`0x$\{string}\`\> - -Transfers a claim fraction to a new owner. - -##### Parameters - -| Name | Type | -| :----------- | :------------------------------------------------------- | -| `fractionId` | `bigint` | -| `to` | \`0x$\{string}\` | -| `overrides?` | [`SupportedOverrides`](../modules.md#supportedoverrides) | - -##### Returns - -`Promise`<`undefined` \| \`0x$\{string}\`\> - -A Promise that resolves to the transaction hash - -#### Defined in - -[sdk/src/types/client.ts:212](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/client.ts#L212) diff --git a/docs/docs/developer/api/sdk/interfaces/HypercertClientState.md b/docs/docs/developer/api/sdk/interfaces/HypercertClientState.md deleted file mode 100644 index dd0967ce..00000000 --- a/docs/docs/developer/api/sdk/interfaces/HypercertClientState.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -id: "HypercertClientState" -title: "Interface: HypercertClientState" -sidebar_label: "HypercertClientState" -sidebar_position: 0 -custom_edit_url: null ---- - -The state of the Hypercert client. - -## Hierarchy - -- **`HypercertClientState`** - - ↳ [`HypercertClientInterface`](HypercertClientInterface.md) - -## Properties - -### indexer - -• **indexer**: `HypercertIndexer` - -The indexer used by the client. - -#### Defined in - -[sdk/src/types/client.ts:172](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/client.ts#L172) - ---- - -### readonly - -• **readonly**: `boolean` - -Whether the client is in read-only mode. - -#### Defined in - -[sdk/src/types/client.ts:168](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/client.ts#L168) - ---- - -### storage - -• **storage**: [`HypercertStorageInterface`](HypercertStorageInterface.md) - -The storage layer used by the client. - -#### Defined in - -[sdk/src/types/client.ts:170](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/client.ts#L170) diff --git a/docs/docs/developer/api/sdk/interfaces/HypercertEvaluationSchema.md b/docs/docs/developer/api/sdk/interfaces/HypercertEvaluationSchema.md deleted file mode 100644 index 9bbd00a4..00000000 --- a/docs/docs/developer/api/sdk/interfaces/HypercertEvaluationSchema.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -id: "HypercertEvaluationSchema" -title: "Interface: HypercertEvaluationSchema" -sidebar_label: "HypercertEvaluationSchema" -sidebar_position: 0 -custom_edit_url: null ---- - -Schema for evaluating Hypercerts across different sources and evaluation types - -## Indexable - -▪ [k: `string`]: `unknown` - -## Properties - -### creator - -• **creator**: `string` - -#### Defined in - -[sdk/src/types/evaluation.d.ts:15](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/evaluation.d.ts#L15) - ---- - -### evaluationData - -• **evaluationData**: [`EvaluationData`](../modules.md#evaluationdata) - -#### Defined in - -[sdk/src/types/evaluation.d.ts:16](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/evaluation.d.ts#L16) - ---- - -### evaluationSource - -• **evaluationSource**: [`EvaluationSource`](../modules.md#evaluationsource) - -#### Defined in - -[sdk/src/types/evaluation.d.ts:17](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/evaluation.d.ts#L17) diff --git a/docs/docs/developer/api/sdk/interfaces/HypercertIndexerInterface.md b/docs/docs/developer/api/sdk/interfaces/HypercertIndexerInterface.md deleted file mode 100644 index 91826145..00000000 --- a/docs/docs/developer/api/sdk/interfaces/HypercertIndexerInterface.md +++ /dev/null @@ -1,174 +0,0 @@ ---- -id: "HypercertIndexerInterface" -title: "Interface: HypercertIndexerInterface" -sidebar_label: "HypercertIndexerInterface" -sidebar_position: 0 -custom_edit_url: null ---- - -## Properties - -### claimById - -• **claimById**: (`id`: `string`) => `Promise`<`undefined` \| [`ClaimByIdQuery`](../modules.md#claimbyidquery)\> - -#### Type declaration - -▸ (`id`): `Promise`<`undefined` \| [`ClaimByIdQuery`](../modules.md#claimbyidquery)\> - -##### Parameters - -| Name | Type | -| :--- | :------- | -| `id` | `string` | - -##### Returns - -`Promise`<`undefined` \| [`ClaimByIdQuery`](../modules.md#claimbyidquery)\> - -#### Defined in - -[sdk/src/types/indexer.ts:23](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/indexer.ts#L23) - ---- - -### claimsByOwner - -• **claimsByOwner**: (`owner`: `string`, `params?`: [`QueryParams`](../modules.md#queryparams)) => `Promise`<`undefined` \| [`ClaimsByOwnerQuery`](../modules.md#claimsbyownerquery)\> - -#### Type declaration - -▸ (`owner`, `params?`): `Promise`<`undefined` \| [`ClaimsByOwnerQuery`](../modules.md#claimsbyownerquery)\> - -##### Parameters - -| Name | Type | -| :-------- | :----------------------------------------- | -| `owner` | `string` | -| `params?` | [`QueryParams`](../modules.md#queryparams) | - -##### Returns - -`Promise`<`undefined` \| [`ClaimsByOwnerQuery`](../modules.md#claimsbyownerquery)\> - -#### Defined in - -[sdk/src/types/indexer.ts:22](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/indexer.ts#L22) - ---- - -### firstClaims - -• **firstClaims**: (`params?`: [`QueryParams`](../modules.md#queryparams)) => `Promise`<`undefined` \| [`RecentClaimsQuery`](../modules.md#recentclaimsquery)\> - -#### Type declaration - -▸ (`params?`): `Promise`<`undefined` \| [`RecentClaimsQuery`](../modules.md#recentclaimsquery)\> - -##### Parameters - -| Name | Type | -| :-------- | :----------------------------------------- | -| `params?` | [`QueryParams`](../modules.md#queryparams) | - -##### Returns - -`Promise`<`undefined` \| [`RecentClaimsQuery`](../modules.md#recentclaimsquery)\> - -#### Defined in - -[sdk/src/types/indexer.ts:24](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/indexer.ts#L24) - ---- - -### fractionById - -• **fractionById**: (`fractionId`: `string`) => `Promise`<`undefined` \| [`ClaimTokenByIdQuery`](../modules.md#claimtokenbyidquery)\> - -#### Type declaration - -▸ (`fractionId`): `Promise`<`undefined` \| [`ClaimTokenByIdQuery`](../modules.md#claimtokenbyidquery)\> - -##### Parameters - -| Name | Type | -| :----------- | :------- | -| `fractionId` | `string` | - -##### Returns - -`Promise`<`undefined` \| [`ClaimTokenByIdQuery`](../modules.md#claimtokenbyidquery)\> - -#### Defined in - -[sdk/src/types/indexer.ts:27](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/indexer.ts#L27) - ---- - -### fractionsByClaim - -• **fractionsByClaim**: (`claimId`: `string`, `params?`: [`QueryParams`](../modules.md#queryparams)) => `Promise`<`undefined` \| [`ClaimTokensByClaimQuery`](../modules.md#claimtokensbyclaimquery)\> - -#### Type declaration - -▸ (`claimId`, `params?`): `Promise`<`undefined` \| [`ClaimTokensByClaimQuery`](../modules.md#claimtokensbyclaimquery)\> - -##### Parameters - -| Name | Type | -| :-------- | :----------------------------------------- | -| `claimId` | `string` | -| `params?` | [`QueryParams`](../modules.md#queryparams) | - -##### Returns - -`Promise`<`undefined` \| [`ClaimTokensByClaimQuery`](../modules.md#claimtokensbyclaimquery)\> - -#### Defined in - -[sdk/src/types/indexer.ts:26](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/indexer.ts#L26) - ---- - -### fractionsByOwner - -• **fractionsByOwner**: (`owner`: `string`, `params?`: [`QueryParams`](../modules.md#queryparams)) => `Promise`<`undefined` \| [`ClaimTokensByOwnerQuery`](../modules.md#claimtokensbyownerquery)\> - -#### Type declaration - -▸ (`owner`, `params?`): `Promise`<`undefined` \| [`ClaimTokensByOwnerQuery`](../modules.md#claimtokensbyownerquery)\> - -##### Parameters - -| Name | Type | -| :-------- | :----------------------------------------- | -| `owner` | `string` | -| `params?` | [`QueryParams`](../modules.md#queryparams) | - -##### Returns - -`Promise`<`undefined` \| [`ClaimTokensByOwnerQuery`](../modules.md#claimtokensbyownerquery)\> - -#### Defined in - -[sdk/src/types/indexer.ts:25](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/indexer.ts#L25) - -## Methods - -### getGraphClient - -▸ **getGraphClient**(`chainId`): `Client` - -#### Parameters - -| Name | Type | -| :-------- | :------- | -| `chainId` | `number` | - -#### Returns - -`Client` - -#### Defined in - -[sdk/src/types/indexer.ts:21](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/indexer.ts#L21) diff --git a/docs/docs/developer/api/sdk/interfaces/HypercertMetadata.md b/docs/docs/developer/api/sdk/interfaces/HypercertMetadata.md deleted file mode 100644 index 2df42b6a..00000000 --- a/docs/docs/developer/api/sdk/interfaces/HypercertMetadata.md +++ /dev/null @@ -1,113 +0,0 @@ ---- -id: "HypercertMetadata" -title: "Interface: HypercertMetadata" -sidebar_label: "HypercertMetadata" -sidebar_position: 0 -custom_edit_url: null ---- - -Claim data for hypercert. ERC1155 Metadata compliant - -## Properties - -### allowList - -• `Optional` **allowList**: `string` - -A CID pointer to the merke tree proof json on ipfs - -#### Defined in - -[sdk/src/types/metadata.d.ts:39](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/metadata.d.ts#L39) - ---- - -### description - -• **description**: `string` - -Describes the asset to which this token represents - -#### Defined in - -[sdk/src/types/metadata.d.ts:19](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/metadata.d.ts#L19) - ---- - -### external_url - -• `Optional` **external_url**: `string` - -An url pointing to the external website of the project - -#### Defined in - -[sdk/src/types/metadata.d.ts:23](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/metadata.d.ts#L23) - ---- - -### hypercert - -• `Optional` **hypercert**: `HypercertClaimdata` - -#### Defined in - -[sdk/src/types/metadata.d.ts:45](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/metadata.d.ts#L45) - ---- - -### image - -• **image**: `string` - -A URI pointing to a resource with mime type image/\* representing the asset to which this token represents. Consider making any images at a width between 320 and 1080 pixels and aspect ratio between 1.91:1 and 4:5 inclusive. - -#### Defined in - -[sdk/src/types/metadata.d.ts:27](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/metadata.d.ts#L27) - ---- - -### name - -• **name**: `string` - -Identifies the asset to which this token represents - -#### Defined in - -[sdk/src/types/metadata.d.ts:15](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/metadata.d.ts#L15) - ---- - -### properties - -• `Optional` **properties**: \{ `[k: string]`: `unknown`; `trait_type?`: `string` ; `value?`: `string` }[] - -#### Defined in - -[sdk/src/types/metadata.d.ts:40](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/metadata.d.ts#L40) - ---- - -### ref - -• `Optional` **ref**: `string` - -Describes the asset to which this token represents - -#### Defined in - -[sdk/src/types/metadata.d.ts:35](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/metadata.d.ts#L35) - ---- - -### version - -• `Optional` **version**: `string` - -The version of Hypercert schema used to describe this hypercert - -#### Defined in - -[sdk/src/types/metadata.d.ts:31](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/metadata.d.ts#L31) diff --git a/docs/docs/developer/api/sdk/interfaces/HypercertPointer.md b/docs/docs/developer/api/sdk/interfaces/HypercertPointer.md deleted file mode 100644 index 0d6489e6..00000000 --- a/docs/docs/developer/api/sdk/interfaces/HypercertPointer.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -id: "HypercertPointer" -title: "Interface: HypercertPointer" -sidebar_label: "HypercertPointer" -sidebar_position: 0 -custom_edit_url: null ---- - -## Indexable - -▪ [k: `string`]: `unknown` - -## Properties - -### chainId - -• **chainId**: `string` - -#### Defined in - -[sdk/src/types/evaluation.d.ts:28](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/evaluation.d.ts#L28) - ---- - -### claimId - -• **claimId**: `string` - -#### Defined in - -[sdk/src/types/evaluation.d.ts:30](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/evaluation.d.ts#L30) - ---- - -### contract - -• **contract**: `string` - -#### Defined in - -[sdk/src/types/evaluation.d.ts:29](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/evaluation.d.ts#L29) diff --git a/docs/docs/developer/api/sdk/interfaces/HypercertStorageInterface.md b/docs/docs/developer/api/sdk/interfaces/HypercertStorageInterface.md deleted file mode 100644 index ddf9e9dc..00000000 --- a/docs/docs/developer/api/sdk/interfaces/HypercertStorageInterface.md +++ /dev/null @@ -1,130 +0,0 @@ ---- -id: "HypercertStorageInterface" -title: "Interface: HypercertStorageInterface" -sidebar_label: "HypercertStorageInterface" -sidebar_position: 0 -custom_edit_url: null ---- - -The interface for the Hypercert storage layer. - -## Implemented by - -- [`HypercertsStorage`](../classes/HypercertsStorage.md) - -## Properties - -### getData - -• **getData**: (`cidOrIpfsUri`: `string`, `config?`: [`StorageConfigOverrides`](../modules.md#storageconfigoverrides)) => `Promise`<`unknown`\> - -#### Type declaration - -▸ (`cidOrIpfsUri`, `config?`): `Promise`<`unknown`\> - -Retrieves arbitrary data from IPFS. - -##### Parameters - -| Name | Type | Description | -| :------------- | :--------------------------------------------------------------- | :------------------------------------------- | -| `cidOrIpfsUri` | `string` | The CID or IPFS URI of the data to retrieve. | -| `config?` | [`StorageConfigOverrides`](../modules.md#storageconfigoverrides) | An optional configuration object. | - -##### Returns - -`Promise`<`unknown`\> - -A Promise that resolves to the retrieved data. - -#### Defined in - -[sdk/src/types/client.ts:147](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/client.ts#L147) - ---- - -### getMetadata - -• **getMetadata**: (`cidOrIpfsUri`: `string`, `config?`: [`StorageConfigOverrides`](../modules.md#storageconfigoverrides)) => `Promise`<[`HypercertMetadata`](HypercertMetadata.md)\> - -#### Type declaration - -▸ (`cidOrIpfsUri`, `config?`): `Promise`<[`HypercertMetadata`](HypercertMetadata.md)\> - -Retrieves the metadata for a hypercerts. - -##### Parameters - -| Name | Type | Description | -| :------------- | :--------------------------------------------------------------- | :----------------------------------------------- | -| `cidOrIpfsUri` | `string` | The CID or IPFS URI of the metadata to retrieve. | -| `config?` | [`StorageConfigOverrides`](../modules.md#storageconfigoverrides) | An optional configuration object. | - -##### Returns - -`Promise`<[`HypercertMetadata`](HypercertMetadata.md)\> - -A Promise that resolves to the retrieved metadata. - -#### Defined in - -[sdk/src/types/client.ts:139](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/client.ts#L139) - ---- - -### storeAllowList - -• **storeAllowList**: (`allowList`: [`AllowlistEntry`](../modules.md#allowlistentry)[], `totalUnits`: `bigint`, `config?`: [`StorageConfigOverrides`](../modules.md#storageconfigoverrides)) => `Promise`<`string`\> - -#### Type declaration - -▸ (`allowList`, `totalUnits`, `config?`): `Promise`<`string`\> - -Stores the allowlost for a hypercert. - -##### Parameters - -| Name | Type | Description | -| :----------- | :--------------------------------------------------------------- | :-------------------------------- | -| `allowList` | [`AllowlistEntry`](../modules.md#allowlistentry)[] | The metadata to store. | -| `totalUnits` | `bigint` | - | -| `config?` | [`StorageConfigOverrides`](../modules.md#storageconfigoverrides) | An optional configuration object. | - -##### Returns - -`Promise`<`string`\> - -A Promise that resolves to the CID of the stored metadata. - -#### Defined in - -[sdk/src/types/client.ts:123](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/client.ts#L123) - ---- - -### storeMetadata - -• **storeMetadata**: (`metadata`: [`HypercertMetadata`](HypercertMetadata.md), `config?`: [`StorageConfigOverrides`](../modules.md#storageconfigoverrides)) => `Promise`<`string`\> - -#### Type declaration - -▸ (`metadata`, `config?`): `Promise`<`string`\> - -Stores the metadata for a hypercert. - -##### Parameters - -| Name | Type | Description | -| :--------- | :--------------------------------------------------------------- | :-------------------------------- | -| `metadata` | [`HypercertMetadata`](HypercertMetadata.md) | The metadata to store. | -| `config?` | [`StorageConfigOverrides`](../modules.md#storageconfigoverrides) | An optional configuration object. | - -##### Returns - -`Promise`<`string`\> - -A Promise that resolves to the CID of the stored metadata. - -#### Defined in - -[sdk/src/types/client.ts:131](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/client.ts#L131) diff --git a/docs/docs/developer/api/sdk/interfaces/IPFSEvaluation.md b/docs/docs/developer/api/sdk/interfaces/IPFSEvaluation.md deleted file mode 100644 index ec56fab6..00000000 --- a/docs/docs/developer/api/sdk/interfaces/IPFSEvaluation.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -id: "IPFSEvaluation" -title: "Interface: IPFSEvaluation" -sidebar_label: "IPFSEvaluation" -sidebar_position: 0 -custom_edit_url: null ---- - -## Indexable - -▪ [k: `string`]: `unknown` - -## Properties - -### cid - -• **cid**: `string` - -#### Defined in - -[sdk/src/types/evaluation.d.ts:48](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/evaluation.d.ts#L48) - ---- - -### type - -• **type**: `"IPFS"` - -#### Defined in - -[sdk/src/types/evaluation.d.ts:47](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/evaluation.d.ts#L47) diff --git a/docs/docs/developer/api/sdk/interfaces/SimpleTextEvaluation.md b/docs/docs/developer/api/sdk/interfaces/SimpleTextEvaluation.md deleted file mode 100644 index 812c8a29..00000000 --- a/docs/docs/developer/api/sdk/interfaces/SimpleTextEvaluation.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -id: "SimpleTextEvaluation" -title: "Interface: SimpleTextEvaluation" -sidebar_label: "SimpleTextEvaluation" -sidebar_position: 0 -custom_edit_url: null ---- - -## Indexable - -▪ [k: `string`]: `unknown` - -## Properties - -### hypercert - -• **hypercert**: [`HypercertPointer`](HypercertPointer.md) - -#### Defined in - -[sdk/src/types/evaluation.d.ts:35](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/evaluation.d.ts#L35) - ---- - -### text - -• **text**: `string` - -#### Defined in - -[sdk/src/types/evaluation.d.ts:36](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/evaluation.d.ts#L36) - ---- - -### type - -• **type**: `"simpleText"` - -#### Defined in - -[sdk/src/types/evaluation.d.ts:34](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/evaluation.d.ts#L34) diff --git a/docs/docs/developer/api/sdk/interfaces/_category_.yml b/docs/docs/developer/api/sdk/interfaces/_category_.yml deleted file mode 100644 index 43bec88c..00000000 --- a/docs/docs/developer/api/sdk/interfaces/_category_.yml +++ /dev/null @@ -1,2 +0,0 @@ -label: "Interfaces" -position: 4 \ No newline at end of file diff --git a/docs/docs/developer/api/sdk/modules.md b/docs/docs/developer/api/sdk/modules.md deleted file mode 100644 index 6e6bc4e2..00000000 --- a/docs/docs/developer/api/sdk/modules.md +++ /dev/null @@ -1,1630 +0,0 @@ ---- -id: "modules" -title: "@hypercerts-org/sdk" -sidebar_label: "Exports" -sidebar_position: 0.5 -custom_edit_url: null ---- - -## Classes - -- [ClientError](classes/ClientError.md) -- [ConfigurationError](classes/ConfigurationError.md) -- [ContractError](classes/ContractError.md) -- [FetchError](classes/FetchError.md) -- [HypercertClient](classes/HypercertClient.md) -- [HypercertsStorage](classes/HypercertsStorage.md) -- [InvalidOrMissingError](classes/InvalidOrMissingError.md) -- [MalformedDataError](classes/MalformedDataError.md) -- [MintingError](classes/MintingError.md) -- [StorageError](classes/StorageError.md) -- [UnknownSchemaError](classes/UnknownSchemaError.md) -- [UnsupportedChainError](classes/UnsupportedChainError.md) - -## Interfaces - -- [CustomError](interfaces/CustomError.md) -- [DuplicateEvaluation](interfaces/DuplicateEvaluation.md) -- [EASEvaluation](interfaces/EASEvaluation.md) -- [HypercertClaimdata](interfaces/HypercertClaimdata.md) -- [HypercertClientInterface](interfaces/HypercertClientInterface.md) -- [HypercertClientMethods](interfaces/HypercertClientMethods.md) -- [HypercertClientState](interfaces/HypercertClientState.md) -- [HypercertEvaluationSchema](interfaces/HypercertEvaluationSchema.md) -- [HypercertIndexerInterface](interfaces/HypercertIndexerInterface.md) -- [HypercertMetadata](interfaces/HypercertMetadata.md) -- [HypercertPointer](interfaces/HypercertPointer.md) -- [HypercertStorageInterface](interfaces/HypercertStorageInterface.md) -- [IPFSEvaluation](interfaces/IPFSEvaluation.md) -- [SimpleTextEvaluation](interfaces/SimpleTextEvaluation.md) - -## Type Aliases - -### AllowlistEntry - -Ƭ **AllowlistEntry**: `Object` - -Represents an entry in an allowlist. - -#### Type declaration - -| Name | Type | -| :-------- | :------- | -| `address` | `string` | -| `units` | `bigint` | - -#### Defined in - -[sdk/src/types/hypercerts.ts:24](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/hypercerts.ts#L24) - ---- - -### Claim - -Ƭ **Claim**: `Object` - -#### Type declaration - -| Name | Type | -| :------------ | :-------------------------------------------- | -| `__typename?` | `"Claim"` | -| `allowlist?` | `Maybe`<`Allowlist`\> | -| `contract` | `Scalars`[`"String"`][``"output"``] | -| `creation` | `Scalars`[`"BigInt"`][``"output"``] | -| `creator?` | `Maybe`<`Scalars`[`"Bytes"`][``"output"``]\> | -| `id` | `Scalars`[`"String"`][``"output"``] | -| `owner?` | `Maybe`<`Scalars`[`"Bytes"`][``"output"``]\> | -| `tokenID` | `Scalars`[`"BigInt"`][``"output"``] | -| `totalUnits?` | `Maybe`<`Scalars`[`"BigInt"`][``"output"``]\> | -| `uri?` | `Maybe`<`Scalars`[`"String"`][``"output"``]\> | - -#### Defined in - -[sdk/src/indexer/gql/graphql.ts:205](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/indexer/gql/graphql.ts#L205) - ---- - -### ClaimByIdQuery - -Ƭ **ClaimByIdQuery**: `Object` - -#### Type declaration - -| Name | Type | -| :------------ | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `__typename?` | `"Query"` | -| `claim?` | \{ `__typename?`: `"Claim"` ; `contract`: `string` ; `creator?`: `any` \| `null` ; `id`: `string` ; `owner?`: `any` \| `null` ; `tokenID`: `any` ; `totalUnits?`: `any` \| `null` ; `uri?`: `string` \| `null` } \| `null` | - -#### Defined in - -[sdk/src/indexer/gql/graphql.ts:1179](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/indexer/gql/graphql.ts#L1179) - ---- - -### ClaimToken - -Ƭ **ClaimToken**: `Object` - -#### Type declaration - -| Name | Type | -| :------------ | :---------------------------------- | -| `__typename?` | `"ClaimToken"` | -| `claim` | [`Claim`](modules.md#claim) | -| `id` | `Scalars`[`"String"`][``"output"``] | -| `offers?` | `Maybe`<`Offer`[]\> | -| `owner` | `Scalars`[`"Bytes"`][``"output"``] | -| `tokenID` | `Scalars`[`"BigInt"`][``"output"``] | -| `units` | `Scalars`[`"BigInt"`][``"output"``] | - -#### Defined in - -[sdk/src/indexer/gql/graphql.ts:218](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/indexer/gql/graphql.ts#L218) - ---- - -### ClaimTokenByIdQuery - -Ƭ **ClaimTokenByIdQuery**: `Object` - -#### Type declaration - -| Name | Type | -| :------------ | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `__typename?` | `"Query"` | -| `claimToken?` | \{ `__typename?`: `"ClaimToken"` ; `claim`: \{ `__typename?`: `"Claim"` ; `creation`: `any` ; `id`: `string` ; `totalUnits?`: `any` \| `null` ; `uri?`: `string` \| `null` } ; `id`: `string` ; `owner`: `any` ; `tokenID`: `any` ; `units`: `any` } \| `null` | - -#### Defined in - -[sdk/src/indexer/gql/graphql.ts:1206](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/indexer/gql/graphql.ts#L1206) - ---- - -### ClaimTokensByClaimQuery - -Ƭ **ClaimTokensByClaimQuery**: `Object` - -#### Type declaration - -| Name | Type | -| :------------ | :--------------------------------------------------------------------------------------------------------- | -| `__typename?` | `"Query"` | -| `claimTokens` | \{ `__typename?`: `"ClaimToken"` ; `id`: `string` ; `owner`: `any` ; `tokenID`: `any` ; `units`: `any` }[] | - -#### Defined in - -[sdk/src/indexer/gql/graphql.ts:1199](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/indexer/gql/graphql.ts#L1199) - ---- - -### ClaimTokensByOwnerQuery - -Ƭ **ClaimTokensByOwnerQuery**: `Object` - -#### Type declaration - -| Name | Type | -| :------------ | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `__typename?` | `"Query"` | -| `claimTokens` | \{ `__typename?`: `"ClaimToken"` ; `claim`: \{ `__typename?`: `"Claim"` ; `creation`: `any` ; `id`: `string` ; `totalUnits?`: `any` \| `null` ; `uri?`: `string` \| `null` } ; `id`: `string` ; `owner`: `any` ; `tokenID`: `any` ; `units`: `any` }[] | - -#### Defined in - -[sdk/src/indexer/gql/graphql.ts:1189](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/indexer/gql/graphql.ts#L1189) - ---- - -### ClaimsByOwnerQuery - -Ƭ **ClaimsByOwnerQuery**: `Object` - -#### Type declaration - -| Name | Type | -| :------------ | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `__typename?` | `"Query"` | -| `claims` | \{ `__typename?`: `"Claim"` ; `contract`: `string` ; `creator?`: `any` \| `null` ; `id`: `string` ; `owner?`: `any` \| `null` ; `tokenID`: `any` ; `totalUnits?`: `any` \| `null` ; `uri?`: `string` \| `null` }[] | - -#### Defined in - -[sdk/src/indexer/gql/graphql.ts:1163](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/indexer/gql/graphql.ts#L1163) - ---- - -### ContractOverrides - -Ƭ **ContractOverrides**: `Object` - -Configuration options for the contract interactions. - -**`Param`** - -The value to send with the transaction (in wei). - -**`Param`** - -The gas price to use for the transaction (in wei). - -**`Param`** - -The gas limit to use for the transaction (in wei). - -#### Type declaration - -| Name | Type | -| :---------- | :------- | -| `gasLimit?` | `bigint` | -| `gasPrice?` | `bigint` | -| `value?` | `bigint` | - -#### Defined in - -[sdk/src/types/client.ts:25](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/client.ts#L25) - ---- - -### Contracts - -Ƭ **Contracts**: `"HypercertMinterUUPS"` \| `"TransferManager"` \| `"ProtocolFeeRecipient"` \| `"HypercertExchange"` \| `"RoyaltyFeeRegistry"` \| `"OrderValidator"` \| `"CreatorFeeManager"` \| `"StrategyCollectionOffer"` \| `"StrategyDutchAuction"` \| `"StrategyItemIdsRange"` \| `"StrategyHypercertCollectionOffer"` \| `"StrategyHypercertDutchAuction"` \| `"StrategyHypercertFractionOffer"` - -#### Defined in - -[sdk/src/types/client.ts:40](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/client.ts#L40) - ---- - -### Deployment - -Ƭ **Deployment**: `Object` - -Represents a deployment of a contract on a specific network. - -#### Type declaration - -| Name | Type | Description | -| :---------- | :--------------------------------------------------------------------------- | :--------------------------------------------------------------------------------------- | -| `addresses` | `Partial`<`Record`<[`Contracts`](modules.md#contracts), \`0x$\{string}\`\>\> | The address of the deployed contract. | -| `chain` | `Partial`<`Chain`\> | - | -| `graphName` | `string` | - | -| `graphUrl` | `string` | The url to the subgraph that indexes the contract events. Override for localized testing | -| `isTestnet` | `boolean` | - | - -#### Defined in - -[sdk/src/types/client.ts:58](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/client.ts#L58) - ---- - -### DocumentType - -Ƭ **DocumentType**<`TDocumentNode`\>: `TDocumentNode` extends `DocumentNode` ? `TType` : `never` - -#### Type parameters - -| Name | Type | -| :-------------- | :------------------------------------ | -| `TDocumentNode` | extends `DocumentNode`<`any`, `any`\> | - -#### Defined in - -[sdk/src/indexer/gql/gql.ts:47](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/indexer/gql/gql.ts#L47) - ---- - -### EvaluationData - -Ƭ **EvaluationData**: [`DuplicateEvaluation`](interfaces/DuplicateEvaluation.md) \| [`SimpleTextEvaluation`](interfaces/SimpleTextEvaluation.md) - -This file was automatically generated by json-schema-to-typescript. -DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file, -and run json-schema-to-typescript to regenerate this file. - -#### Defined in - -[sdk/src/types/evaluation.d.ts:8](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/evaluation.d.ts#L8) - ---- - -### EvaluationSource - -Ƭ **EvaluationSource**: [`EASEvaluation`](interfaces/EASEvaluation.md) \| [`IPFSEvaluation`](interfaces/IPFSEvaluation.md) - -#### Defined in - -[sdk/src/types/evaluation.d.ts:9](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/evaluation.d.ts#L9) - ---- - -### FragmentType - -Ƭ **FragmentType**<`TDocumentType`\>: `TDocumentType` extends `DocumentTypeDecoration` ? [`TType`] extends [\{ ` $fragmentName?`: infer TKey }] ? `TKey` extends `string` ? \{ ` $fragmentRefs?`: \{ [key in TKey]: TType } } : `never` : `never` : `never` - -#### Type parameters - -| Name | Type | -| :-------------- | :---------------------------------------------- | -| `TDocumentType` | extends `DocumentTypeDecoration`<`any`, `any`\> | - -#### Defined in - -[sdk/src/indexer/gql/fragment-masking.ts:6](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/indexer/gql/fragment-masking.ts#L6) - ---- - -### HypercertClientConfig - -Ƭ **HypercertClientConfig**: `Pick`<[`Deployment`](modules.md#deployment), `"addresses"` \| `"chain"`\> & [`HypercertStorageConfig`](modules.md#hypercertstorageconfig) & [`HypercertEvaluatorConfig`](modules.md#hypercertevaluatorconfig) & \{ `indexerEnvironment`: [`IndexerEnvironment`](modules.md#indexerenvironment) ; `publicClient`: `PublicClient` ; `readOnly`: `boolean` ; `readOnlyReason?`: `string` ; `unsafeForceOverrideConfig?`: `boolean` ; `walletClient`: `WalletClient` } - -Configuration options for the Hypercert client. - -#### Defined in - -[sdk/src/types/client.ts:71](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/client.ts#L71) - ---- - -### HypercertClientProps - -Ƭ **HypercertClientProps**: `Object` - -The props for the Hypercert client. - -#### Type declaration - -| Name | Type | Description | -| :-------- | :---------------------------------------------------------------------- | :-------------------------------------------------- | -| `config?` | `Partial`<[`HypercertClientConfig`](modules.md#hypercertclientconfig)\> | The configuration options for the Hypercert client. | - -#### Defined in - -[sdk/src/types/client.ts:153](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/client.ts#L153) - ---- - -### HypercertEvaluatorConfig - -Ƭ **HypercertEvaluatorConfig**: `Omit`<`PartialTypedDataConfig`, `"address"`\> & \{ `easContractAddress`: `string` } - -Configuration options for the Hypercert evaluator. - -**`Note`** - -The signer is required for submitting evaluations. - -#### Defined in - -[sdk/src/types/client.ts:109](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/client.ts#L109) - ---- - -### HypercertStorageConfig - -Ƭ **HypercertStorageConfig**: `Object` - -Configuration options for the Hypercert storage layer. - -**`Note`** - -The API tokens are optional, but required for storing data on NFT.storage and Web3.storage. - -**`Deprecated`** - -nft.storage and web3.storage are no longer used - -#### Type declaration - -| Name | Type | Description | -| :----------------- | :------- | :----------------------------- | -| `nftStorageToken?` | `string` | The API token for NFT.storage. | - -#### Defined in - -[sdk/src/types/client.ts:100](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/client.ts#L100) - ---- - -### HypercertsSdkError - -Ƭ **HypercertsSdkError**: [`ConfigurationError`](classes/ConfigurationError.md) \| [`FetchError`](classes/FetchError.md) \| [`InvalidOrMissingError`](classes/InvalidOrMissingError.md) \| [`MalformedDataError`](classes/MalformedDataError.md) \| [`MintingError`](classes/MintingError.md) \| [`StorageError`](classes/StorageError.md) \| [`UnsupportedChainError`](classes/UnsupportedChainError.md) \| [`UnknownSchemaError`](classes/UnknownSchemaError.md) - -#### Defined in - -[sdk/src/types/errors.ts:195](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/errors.ts#L195) - ---- - -### IndexerEnvironment - -Ƭ **IndexerEnvironment**: `"production"` \| `"test"` \| `"all"` - -The environment to run the indexer in. -Production will run against all mainnet chains, while test will run against testnet chains. -All will run against both - -#### Defined in - -[sdk/src/types/client.ts:92](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/client.ts#L92) - ---- - -### QueryParams - -Ƭ **QueryParams**: `Object` - -#### Index signature - -▪ [key: `string`]: `string` \| `number` \| `undefined` - -#### Type declaration - -| Name | Type | -| :---------------- | :------------------ | -| `first` | `number` | -| `orderDirections` | `"asc"` \| `"desc"` | -| `skip` | `number` | - -#### Defined in - -[sdk/src/types/indexer.ts:11](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/indexer.ts#L11) - ---- - -### QueryParamsWithChainId - -Ƭ **QueryParamsWithChainId**: [`QueryParams`](modules.md#queryparams) & \{ `chainId?`: `number` } - -#### Defined in - -[sdk/src/types/indexer.ts:18](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/indexer.ts#L18) - ---- - -### RecentClaimsQuery - -Ƭ **RecentClaimsQuery**: `Object` - -#### Type declaration - -| Name | Type | -| :------------ | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `__typename?` | `"Query"` | -| `claims` | \{ `__typename?`: `"Claim"` ; `contract`: `string` ; `creator?`: `any` \| `null` ; `id`: `string` ; `owner?`: `any` \| `null` ; `tokenID`: `any` ; `totalUnits?`: `any` \| `null` ; `uri?`: `string` \| `null` }[] | - -#### Defined in - -[sdk/src/indexer/gql/graphql.ts:1172](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/indexer/gql/graphql.ts#L1172) - ---- - -### StorageConfigOverrides - -Ƭ **StorageConfigOverrides**: `Object` - -Configuration options for the Hypercert storage layer. - -**`Param`** - -The timeout (im ms) for the HTTP request; for example for uploading metadata or fetching allowlists. - -#### Type declaration - -| Name | Type | -| :--------- | :------- | -| `timeout?` | `number` | - -#### Defined in - -[sdk/src/types/client.ts:35](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/client.ts#L35) - ---- - -### SupportedChainIds - -Ƭ **SupportedChainIds**: `10` \| `42220` \| `11155111` \| `84532` \| `8453` - -Enum to verify the supported chainIds - -**`Note`** - -10 = Optimism, 42220 = Celo, 11155111 = Sepolia, 84532 = Base Sepolia, 8453 = Base Mainnet - -#### Defined in - -[sdk/src/types/client.ts:14](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/client.ts#L14) - ---- - -### SupportedOverrides - -Ƭ **SupportedOverrides**: [`ContractOverrides`](modules.md#contractoverrides) & [`StorageConfigOverrides`](modules.md#storageconfigoverrides) - -#### Defined in - -[sdk/src/types/client.ts:16](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/client.ts#L16) - ---- - -### TransferRestrictions - -Ƭ **TransferRestrictions**: typeof [`TransferRestrictions`](modules.md#transferrestrictions-1)[keyof typeof [`TransferRestrictions`](modules.md#transferrestrictions-1)] - -#### Defined in - -[sdk/src/types/hypercerts.ts:9](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/hypercerts.ts#L9) - -[sdk/src/types/hypercerts.ts:15](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/hypercerts.ts#L15) - -## Variables - -### CreatorFeeManagerWithRoyaltiesAbi - -• **CreatorFeeManagerWithRoyaltiesAbi**: (\{ `inputs`: \{ `internalType`: `string` = "address"; `name`: `string` = "\_royaltyFeeRegistry"; `type`: `string` = "address" }[] ; `name?`: `undefined` = "balanceOf"; `outputs?`: `undefined` ; `stateMutability`: `string` = "nonpayable"; `type`: `string` = "constructor" } \| \{ `inputs`: \{ `internalType`: `string` = "address"; `name`: `string` = "collection"; `type`: `string` = "address" }[] ; `name`: `string` = "BundleEIP2981NotAllowed"; `outputs?`: `undefined` ; `stateMutability?`: `undefined` = "view"; `type`: `string` = "error" } \| \{ `inputs`: \{ `internalType`: `string` = "address"; `name`: `string` = "collection"; `type`: `string` = "address" }[] ; `name`: `string` = "viewCreatorFeeInfo"; `outputs`: \{ `internalType`: `string` = "address"; `name`: `string` = "creator"; `type`: `string` = "address" }[] ; `stateMutability`: `string` = "view"; `type`: `string` = "function" })[] - -#### Defined in - -node*modules/.pnpm/@hypercerts-org+contracts@1.1.2_bufferutil@4.0.8_ts-node@10.9.1*@types+node@18.18.7_typescrip_eax5b4m2ds4kxb2pavx44azaaq/node_modules/@hypercerts-org/contracts/dist/index.d.ts:5790 - ---- - -### ExecutionManagerAbi - -• **ExecutionManagerAbi**: (\{ `anonymous?`: `undefined` = false; `inputs`: \{ `internalType`: `string` = "address"; `name`: `string` = "\_owner"; `type`: `string` = "address" }[] ; `name?`: `undefined` = "balanceOf"; `outputs?`: `undefined` ; `stateMutability`: `string` = "nonpayable"; `type`: `string` = "constructor" } \| \{ `anonymous?`: `undefined` = false; `inputs`: \{ `internalType`: `string` = "uint256"; `name`: `string` = "strategyId"; `type`: `string` = "uint256" }[] ; `name`: `string` = "StrategyNotAvailable"; `outputs?`: `undefined` ; `stateMutability?`: `undefined` = "view"; `type`: `string` = "error" } \| \{ `anonymous`: `boolean` = false; `inputs`: \{ `indexed`: `boolean` = false; `internalType`: `string` = "address"; `name`: `string` = "currency"; `type`: `string` = "address" }[] ; `name`: `string` = "CurrencyStatusUpdated"; `outputs?`: `undefined` ; `stateMutability?`: `undefined` = "view"; `type`: `string` = "event" } \| \{ `anonymous?`: `undefined` = false; `inputs`: \{ `internalType`: `string` = "address"; `name`: `string` = ""; `type`: `string` = "address" }[] ; `name`: `string` = "isCurrencyAllowed"; `outputs`: \{ `internalType`: `string` = "bool"; `name`: `string` = ""; `type`: `string` = "bool" }[] ; `stateMutability`: `string` = "view"; `type`: `string` = "function" })[] - -#### Defined in - -node*modules/.pnpm/@hypercerts-org+contracts@1.1.2_bufferutil@4.0.8_ts-node@10.9.1*@types+node@18.18.7_typescrip_eax5b4m2ds4kxb2pavx44azaaq/node_modules/@hypercerts-org/contracts/dist/index.d.ts:6914 - ---- - -### HypercertExchangeAbi - -• **HypercertExchangeAbi**: (\{ `anonymous?`: `undefined` = false; `inputs`: \{ `internalType`: `string` = "address"; `name`: `string` = "\_owner"; `type`: `string` = "address" }[] ; `name?`: `undefined` = "balanceOf"; `outputs?`: `undefined` ; `stateMutability`: `string` = "nonpayable"; `type`: `string` = "constructor" } \| \{ `anonymous?`: `undefined` = false; `inputs`: \{ `internalType`: `string` = "uint256"; `name`: `string` = "length"; `type`: `string` = "uint256" }[] ; `name`: `string` = "MerkleProofTooLarge"; `outputs?`: `undefined` ; `stateMutability?`: `undefined` = "view"; `type`: `string` = "error" } \| \{ `anonymous`: `boolean` = false; `inputs`: (\{ `components`: \{ `internalType`: `string` = "bytes32"; `name`: `string` = "orderHash"; `type`: `string` = "bytes32" }[] ; `indexed`: `boolean` = false; `internalType`: `string` = "struct ILooksRareProtocol.NonceInvalidationParameters"; `name`: `string` = "nonceInvalidationParameters"; `type`: `string` = "tuple" } \| \{ `components?`: `undefined` ; `indexed`: `boolean` = false; `internalType`: `string` = "address"; `name`: `string` = "askUser"; `type`: `string` = "address" })[] ; `name`: `string` = "TakerAsk"; `outputs?`: `undefined` ; `stateMutability?`: `undefined` = "view"; `type`: `string` = "event" } \| \{ `anonymous?`: `undefined` = false; `inputs`: (\{ `components?`: `undefined` ; `internalType`: `string` = "bytes[]"; `name`: `string` = "makerSignatures"; `type`: `string` = "bytes[]" } \| \{ `components`: (\{ `components?`: `undefined` ; `internalType`: `string` = "bytes32"; `name`: `string` = "root"; `type`: `string` = "bytes32" } \| \{ `components`: \{ `internalType`: `string` = "bytes32"; `name`: `string` = "value"; `type`: `string` = "bytes32" }[] ; `internalType`: `string` = "struct OrderStructs.MerkleTreeNode[]"; `name`: `string` = "proof"; `type`: `string` = "tuple[]" })[] ; `internalType`: `string` = "struct OrderStructs.MerkleTree[]"; `name`: `string` = "merkleTrees"; `type`: `string` = "tuple[]" })[] ; `name`: `string` = "executeMultipleTakerBids"; `outputs`: `never`[] = []; `stateMutability`: `string` = "payable"; `type`: `string` = "function" } \| \{ `anonymous?`: `undefined` = false; `inputs`: (\{ `components`: \{ `internalType`: `string` = "address"; `name`: `string` = "recipient"; `type`: `string` = "address" }[] ; `internalType`: `string` = "struct OrderStructs.Taker"; `name`: `string` = "takerBid"; `type`: `string` = "tuple" } \| \{ `components?`: `undefined` ; `internalType`: `string` = "address"; `name`: `string` = "sender"; `type`: `string` = "address" })[] ; `name`: `string` = "restrictedExecuteTakerBid"; `outputs`: \{ `internalType`: `string` = "uint256"; `name`: `string` = "protocolFeeAmount"; `type`: `string` = "uint256" }[] ; `stateMutability`: `string` = "nonpayable"; `type`: `string` = "function" })[] - -#### Defined in - -node*modules/.pnpm/@hypercerts-org+contracts@1.1.2_bufferutil@4.0.8_ts-node@10.9.1*@types+node@18.18.7_typescrip_eax5b4m2ds4kxb2pavx44azaaq/node_modules/@hypercerts-org/contracts/dist/index.d.ts:1234 - ---- - -### HypercertMinterAbi - -• **HypercertMinterAbi**: (\{ `anonymous?`: `undefined` = false; `inputs`: `never`[] = []; `name?`: `undefined` = "balanceOf"; `outputs?`: `undefined` ; `stateMutability`: `string` = "nonpayable"; `type`: `string` = "constructor" } \| \{ `anonymous?`: `undefined` = false; `inputs`: `never`[] = []; `name`: `string` = "AlreadyClaimed"; `outputs?`: `undefined` ; `stateMutability?`: `undefined` = "view"; `type`: `string` = "error" } \| \{ `anonymous`: `boolean` = false; `inputs`: \{ `indexed`: `boolean` = false; `internalType`: `string` = "address"; `name`: `string` = "previousAdmin"; `type`: `string` = "address" }[] ; `name`: `string` = "AdminChanged"; `outputs?`: `undefined` ; `stateMutability?`: `undefined` = "view"; `type`: `string` = "event" } \| \{ `anonymous?`: `undefined` = false; `inputs`: \{ `internalType`: `string` = "address"; `name`: `string` = "account"; `type`: `string` = "address" }[] ; `name`: `string` = "balanceOf"; `outputs`: \{ `internalType`: `string` = "uint256"; `name`: `string` = ""; `type`: `string` = "uint256" }[] ; `stateMutability`: `string` = "view"; `type`: `string` = "function" })[] - -#### Defined in - -node*modules/.pnpm/@hypercerts-org+contracts@1.1.2_bufferutil@4.0.8_ts-node@10.9.1*@types+node@18.18.7_typescrip_eax5b4m2ds4kxb2pavx44azaaq/node_modules/@hypercerts-org/contracts/dist/index.d.ts:43 - ---- - -### OrderValidatorV2AAbi - -• **OrderValidatorV2AAbi**: (\{ `inputs`: \{ `internalType`: `string` = "address"; `name`: `string` = "\_looksRareProtocol"; `type`: `string` = "address" }[] ; `name?`: `undefined` = "balanceOf"; `outputs?`: `undefined` ; `stateMutability`: `string` = "nonpayable"; `type`: `string` = "constructor" } \| \{ `inputs`: (\{ `components?`: `undefined` ; `internalType`: `string` = "bytes"; `name`: `string` = "signature"; `type`: `string` = "bytes" } \| \{ `components`: (\{ `components?`: `undefined` ; `internalType`: `string` = "bytes32"; `name`: `string` = "root"; `type`: `string` = "bytes32" } \| \{ `components`: \{ `internalType`: `string` = "bytes32"; `name`: `string` = "value"; `type`: `string` = "bytes32" }[] ; `internalType`: `string` = "struct OrderStructs.MerkleTreeNode[]"; `name`: `string` = "proof"; `type`: `string` = "tuple[]" })[] ; `internalType`: `string` = "struct OrderStructs.MerkleTree"; `name`: `string` = "merkleTree"; `type`: `string` = "tuple" })[] ; `name`: `string` = "checkMakerOrderValidity"; `outputs`: \{ `internalType`: `string` = "uint256[9]"; `name`: `string` = "validationCodes"; `type`: `string` = "uint256[9]" }[] ; `stateMutability`: `string` = "view"; `type`: `string` = "function" })[] - -#### Defined in - -node*modules/.pnpm/@hypercerts-org+contracts@1.1.2_bufferutil@4.0.8_ts-node@10.9.1*@types+node@18.18.7_typescrip_eax5b4m2ds4kxb2pavx44azaaq/node_modules/@hypercerts-org/contracts/dist/index.d.ts:3079 - ---- - -### StrategyCollectionOfferAbi - -• **StrategyCollectionOfferAbi**: (\{ `inputs`: `never`[] = []; `name`: `string` = "CollectionTypeInvalid"; `outputs?`: `undefined` ; `stateMutability?`: `undefined` = "view"; `type`: `string` = "error" } \| \{ `inputs`: (\{ `components`: \{ `internalType`: `string` = "enum QuoteType"; `name`: `string` = "quoteType"; `type`: `string` = "uint8" }[] ; `internalType`: `string` = "struct OrderStructs.Maker"; `name`: `string` = "makerBid"; `type`: `string` = "tuple" } \| \{ `components?`: `undefined` ; `internalType`: `string` = "bytes4"; `name`: `string` = "functionSelector"; `type`: `string` = "bytes4" })[] ; `name`: `string` = "isMakerOrderValid"; `outputs`: \{ `internalType`: `string` = "bool"; `name`: `string` = "isValid"; `type`: `string` = "bool" }[] ; `stateMutability`: `string` = "pure"; `type`: `string` = "function" })[] - -#### Defined in - -node*modules/.pnpm/@hypercerts-org+contracts@1.1.2_bufferutil@4.0.8_ts-node@10.9.1*@types+node@18.18.7_typescrip_eax5b4m2ds4kxb2pavx44azaaq/node_modules/@hypercerts-org/contracts/dist/index.d.ts:4593 - ---- - -### StrategyDutchAuctionAbi - -• **StrategyDutchAuctionAbi**: (\{ `inputs`: `never`[] = []; `name`: `string` = "BidTooLow"; `outputs?`: `undefined` ; `stateMutability?`: `undefined` = "view"; `type`: `string` = "error" } \| \{ `inputs`: (\{ `components`: \{ `internalType`: `string` = "enum QuoteType"; `name`: `string` = "quoteType"; `type`: `string` = "uint8" }[] ; `internalType`: `string` = "struct OrderStructs.Maker"; `name`: `string` = "makerAsk"; `type`: `string` = "tuple" } \| \{ `components?`: `undefined` ; `internalType`: `string` = "bytes4"; `name`: `string` = "functionSelector"; `type`: `string` = "bytes4" })[] ; `name`: `string` = "isMakerOrderValid"; `outputs`: \{ `internalType`: `string` = "bool"; `name`: `string` = "isValid"; `type`: `string` = "bool" }[] ; `stateMutability`: `string` = "pure"; `type`: `string` = "function" })[] - -#### Defined in - -node*modules/.pnpm/@hypercerts-org+contracts@1.1.2_bufferutil@4.0.8_ts-node@10.9.1*@types+node@18.18.7_typescrip_eax5b4m2ds4kxb2pavx44azaaq/node_modules/@hypercerts-org/contracts/dist/index.d.ts:5118 - ---- - -### StrategyHypercertCollectionOfferAbi - -• **StrategyHypercertCollectionOfferAbi**: (\{ `inputs`: `never`[] = []; `name`: `string` = "CollectionTypeInvalid"; `outputs?`: `undefined` ; `stateMutability?`: `undefined` = "view"; `type`: `string` = "error" } \| \{ `inputs`: (\{ `components`: \{ `internalType`: `string` = "enum QuoteType"; `name`: `string` = "quoteType"; `type`: `string` = "uint8" }[] ; `internalType`: `string` = "struct OrderStructs.Maker"; `name`: `string` = "makerBid"; `type`: `string` = "tuple" } \| \{ `components?`: `undefined` ; `internalType`: `string` = "bytes4"; `name`: `string` = "functionSelector"; `type`: `string` = "bytes4" })[] ; `name`: `string` = "isMakerOrderValid"; `outputs`: \{ `internalType`: `string` = "bool"; `name`: `string` = "isValid"; `type`: `string` = "bool" }[] ; `stateMutability`: `string` = "pure"; `type`: `string` = "function" })[] - -#### Defined in - -node*modules/.pnpm/@hypercerts-org+contracts@1.1.2_bufferutil@4.0.8_ts-node@10.9.1*@types+node@18.18.7_typescrip_eax5b4m2ds4kxb2pavx44azaaq/node_modules/@hypercerts-org/contracts/dist/index.d.ts:5863 - ---- - -### StrategyHypercertDutchAuctionAbi - -• **StrategyHypercertDutchAuctionAbi**: (\{ `inputs`: `never`[] = []; `name`: `string` = "BidTooLow"; `outputs?`: `undefined` ; `stateMutability?`: `undefined` = "view"; `type`: `string` = "error" } \| \{ `inputs`: (\{ `components`: \{ `internalType`: `string` = "enum QuoteType"; `name`: `string` = "quoteType"; `type`: `string` = "uint8" }[] ; `internalType`: `string` = "struct OrderStructs.Maker"; `name`: `string` = "makerAsk"; `type`: `string` = "tuple" } \| \{ `components?`: `undefined` ; `internalType`: `string` = "bytes4"; `name`: `string` = "functionSelector"; `type`: `string` = "bytes4" })[] ; `name`: `string` = "isMakerOrderValid"; `outputs`: \{ `internalType`: `string` = "bool"; `name`: `string` = "isValid"; `type`: `string` = "bool" }[] ; `stateMutability`: `string` = "view"; `type`: `string` = "function" })[] - -#### Defined in - -node*modules/.pnpm/@hypercerts-org+contracts@1.1.2_bufferutil@4.0.8_ts-node@10.9.1*@types+node@18.18.7_typescrip_eax5b4m2ds4kxb2pavx44azaaq/node_modules/@hypercerts-org/contracts/dist/index.d.ts:6388 - ---- - -### StrategyHypercertFractionOfferAbi - -• **StrategyHypercertFractionOfferAbi**: (\{ `inputs`: `never`[] = []; `name`: `string` = "AmountInvalid"; `outputs?`: `undefined` ; `stateMutability?`: `undefined` = "view"; `type`: `string` = "error" } \| \{ `inputs`: (\{ `components`: \{ `internalType`: `string` = "enum QuoteType"; `name`: `string` = "quoteType"; `type`: `string` = "uint8" }[] ; `internalType`: `string` = "struct OrderStructs.Maker"; `name`: `string` = "makerAsk"; `type`: `string` = "tuple" } \| \{ `components?`: `undefined` ; `internalType`: `string` = "bytes4"; `name`: `string` = "functionSelector"; `type`: `string` = "bytes4" })[] ; `name`: `string` = "isMakerOrderValid"; `outputs`: \{ `internalType`: `string` = "bool"; `name`: `string` = "isValid"; `type`: `string` = "bool" }[] ; `stateMutability`: `string` = "view"; `type`: `string` = "function" })[] - -#### Defined in - -node*modules/.pnpm/@hypercerts-org+contracts@1.1.2_bufferutil@4.0.8_ts-node@10.9.1*@types+node@18.18.7_typescrip_eax5b4m2ds4kxb2pavx44azaaq/node_modules/@hypercerts-org/contracts/dist/index.d.ts:5387 - ---- - -### StrategyItemIdsRangeAbi - -• **StrategyItemIdsRangeAbi**: (\{ `inputs`: `never`[] = []; `name`: `string` = "OrderInvalid"; `outputs?`: `undefined` ; `stateMutability?`: `undefined` = "view"; `type`: `string` = "error" } \| \{ `inputs`: (\{ `components`: \{ `internalType`: `string` = "enum QuoteType"; `name`: `string` = "quoteType"; `type`: `string` = "uint8" }[] ; `internalType`: `string` = "struct OrderStructs.Maker"; `name`: `string` = "makerBid"; `type`: `string` = "tuple" } \| \{ `components?`: `undefined` ; `internalType`: `string` = "bytes4"; `name`: `string` = "functionSelector"; `type`: `string` = "bytes4" })[] ; `name`: `string` = "isMakerOrderValid"; `outputs`: \{ `internalType`: `string` = "bool"; `name`: `string` = "isValid"; `type`: `string` = "bool" }[] ; `stateMutability`: `string` = "pure"; `type`: `string` = "function" })[] - -#### Defined in - -node*modules/.pnpm/@hypercerts-org+contracts@1.1.2_bufferutil@4.0.8_ts-node@10.9.1*@types+node@18.18.7_typescrip_eax5b4m2ds4kxb2pavx44azaaq/node_modules/@hypercerts-org/contracts/dist/index.d.ts:6657 - ---- - -### StrategyManagerAbi - -• **StrategyManagerAbi**: (\{ `anonymous?`: `undefined` = false; `inputs`: \{ `internalType`: `string` = "address"; `name`: `string` = "\_owner"; `type`: `string` = "address" }[] ; `name?`: `undefined` = "balanceOf"; `outputs?`: `undefined` ; `stateMutability`: `string` = "nonpayable"; `type`: `string` = "constructor" } \| \{ `anonymous?`: `undefined` = false; `inputs`: `never`[] = []; `name`: `string` = "NoOngoingTransferInProgress"; `outputs?`: `undefined` ; `stateMutability?`: `undefined` = "view"; `type`: `string` = "error" } \| \{ `anonymous`: `boolean` = false; `inputs`: \{ `indexed`: `boolean` = false; `internalType`: `string` = "address"; `name`: `string` = "currency"; `type`: `string` = "address" }[] ; `name`: `string` = "CurrencyStatusUpdated"; `outputs?`: `undefined` ; `stateMutability?`: `undefined` = "view"; `type`: `string` = "event" } \| \{ `anonymous?`: `undefined` = false; `inputs`: \{ `internalType`: `string` = "address"; `name`: `string` = ""; `type`: `string` = "address" }[] ; `name`: `string` = "isCurrencyAllowed"; `outputs`: \{ `internalType`: `string` = "bool"; `name`: `string` = ""; `type`: `string` = "bool" }[] ; `stateMutability`: `string` = "view"; `type`: `string` = "function" })[] - -#### Defined in - -node*modules/.pnpm/@hypercerts-org+contracts@1.1.2_bufferutil@4.0.8_ts-node@10.9.1*@types+node@18.18.7_typescrip_eax5b4m2ds4kxb2pavx44azaaq/node_modules/@hypercerts-org/contracts/dist/index.d.ts:3516 - ---- - -### TransferManagerAbi - -• **TransferManagerAbi**: (\{ `anonymous?`: `undefined` = false; `inputs`: \{ `internalType`: `string` = "address"; `name`: `string` = "\_owner"; `type`: `string` = "address" }[] ; `name?`: `undefined` = "balanceOf"; `outputs?`: `undefined` ; `stateMutability`: `string` = "nonpayable"; `type`: `string` = "constructor" } \| \{ `anonymous?`: `undefined` = false; `inputs`: `never`[] = []; `name`: `string` = "AmountInvalid"; `outputs?`: `undefined` ; `stateMutability?`: `undefined` = "view"; `type`: `string` = "error" } \| \{ `anonymous`: `boolean` = false; `inputs`: \{ `indexed`: `boolean` = false; `internalType`: `string` = "address"; `name`: `string` = "user"; `type`: `string` = "address" }[] ; `name`: `string` = "ApprovalsGranted"; `outputs?`: `undefined` ; `stateMutability?`: `undefined` = "view"; `type`: `string` = "event" } \| \{ `anonymous?`: `undefined` = false; `inputs`: \{ `internalType`: `string` = "address"; `name`: `string` = ""; `type`: `string` = "address" }[] ; `name`: `string` = "hasUserApprovedOperator"; `outputs`: \{ `internalType`: `string` = "bool"; `name`: `string` = ""; `type`: `string` = "bool" }[] ; `stateMutability`: `string` = "view"; `type`: `string` = "function" } \| \{ `anonymous?`: `undefined` = false; `inputs`: (\{ `components`: \{ `internalType`: `string` = "address"; `name`: `string` = "collection"; `type`: `string` = "address" }[] ; `internalType`: `string` = "struct ITransferManager.BatchTransferItem[]"; `name`: `string` = "items"; `type`: `string` = "tuple[]" } \| \{ `components?`: `undefined` ; `internalType`: `string` = "address"; `name`: `string` = "from"; `type`: `string` = "address" })[] ; `name`: `string` = "transferBatchItemsAcrossCollections"; `outputs`: `never`[] = []; `stateMutability`: `string` = "nonpayable"; `type`: `string` = "function" })[] - -#### Defined in - -node*modules/.pnpm/@hypercerts-org+contracts@1.1.2_bufferutil@4.0.8_ts-node@10.9.1*@types+node@18.18.7_typescrip_eax5b4m2ds4kxb2pavx44azaaq/node_modules/@hypercerts-org/contracts/dist/index.d.ts:3982 - ---- - -### TransferRestrictions - -• `Const` **TransferRestrictions**: `Object` - -Represents the possible transfer restrictions of a claim matching the hypercerts protocol. - -#### Type declaration - -| Name | Type | -| :---------------- | :--- | -| `AllowAll` | `0` | -| `DisallowAll` | `1` | -| `FromCreatorOnly` | `2` | - -#### Defined in - -[sdk/src/types/hypercerts.ts:9](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/hypercerts.ts#L9) - -[sdk/src/types/hypercerts.ts:15](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/hypercerts.ts#L15) - ---- - -### apis - -• `Const` **apis**: `Object` - -#### Index signature - -▪ [key: `string`]: `string` - -#### Defined in - -[sdk/src/constants.ts:13](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/constants.ts#L13) - ---- - -### deployments - -• `Const` **deployments**: \{ [key in SupportedChainIds]: Partial } - -#### Defined in - -[sdk/src/constants.ts:19](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/constants.ts#L19) - ---- - -### logger - -• `Const` **logger**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :-------------------------------------------------------------------------- | -| `debug` | (`message`: `string`, `label?`: `string`, ...`data`: `unknown`[]) => `void` | -| `error` | (`error`: `Error`, `label?`: `string`) => `void` | -| `info` | (`message`: `string`, `label?`: `string`, ...`data`: `unknown`[]) => `void` | -| `warn` | (`message`: `string`, `label?`: `string`, ...`data`: `unknown`[]) => `void` | - -#### Defined in - -[sdk/src/utils/logger.ts:24](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/utils/logger.ts#L24) - -## Functions - -### formatHypercertData - -▸ **formatHypercertData**(`«destructured»`): `FormatResult` - -Formats input data to an object containing HypercertMetadata including appropriate labels - -#### Parameters - -| Name | Type | -| :----------------------- | :------------------------------------------------ | -| `«destructured»` | `Object` | -| › `contributors` | `string`[] | -| › `description` | `string` | -| › `excludedImpactScope` | `string`[] | -| › `excludedRights` | `string`[] | -| › `excludedWorkScope` | `string`[] | -| › `external_url?` | `string` | -| › `image` | `string` | -| › `impactScope` | `string`[] | -| › `impactTimeframeEnd` | `number` | -| › `impactTimeframeStart` | `number` | -| › `name` | `string` | -| › `properties?` | \{ `trait_type`: `string` ; `value`: `string` }[] | -| › `rights` | `string`[] | -| › `version` | `string` | -| › `workScope` | `string`[] | -| › `workTimeframeEnd` | `number` | -| › `workTimeframeStart` | `number` | - -#### Returns - -`FormatResult` - -#### Defined in - -[sdk/src/utils/formatter.ts:27](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/utils/formatter.ts#L27) - ---- - -### getClaimStoredDataFromTxHash - -▸ **getClaimStoredDataFromTxHash**(`client`, `hash`): `Promise`<`ParserReturnType`\> - -Utility method to parse a hypercert mint transaction (createAllowlist, mintClaim) and get the ID of the minted claim - -#### Parameters - -| Name | Type | Description | -| :-------------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `client` | `Object` | public client provided by viem | -| `client.account` | `undefined` | The Account of the Client. | -| `client.batch?` | `Object` | Flags for batch settings. | -| `client.batch.multicall?` | `boolean` \| \{ batchSize?: number \| undefined; wait?: number \| undefined; } | Toggle to enable `eth_call` multicall aggregation. | -| `client.cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | -| `client.call` | (`parameters`: `CallParameters`<`undefined` \| `Chain`\>) => `Promise`<`CallReturnType`\> | Executes a new message call immediately without submitting a transaction to the network. - Docs: https://viem.sh/docs/actions/public/call - JSON-RPC Methods: [`eth_call`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_call) **`Example`** `ts import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const data = await client.call({ account: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266', data: '0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2', to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8', }) ` | -| `client.ccipRead?` | `false` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | -| `client.chain` | `undefined` \| `Chain` | Chain for the client. | -| `client.createBlockFilter` | () => `Promise`<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn` ; `type`: `"block"` }\> | Creates a Filter to listen for new block hashes that can be used with [`getFilterChanges`](https://viem.sh/docs/actions/public/getFilterChanges). - Docs: https://viem.sh/docs/actions/public/createBlockFilter - JSON-RPC Methods: [`eth_newBlockFilter`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_newBlockFilter) **`Example`** `ts import { createPublicClient, createBlockFilter, http } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const filter = await createBlockFilter(client) // { id: "0x345a6572337856574a76364e457a4366", type: 'block' } ` | -| `client.createContractEventFilter` | (`args`: `CreateContractEventFilterParameters`<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`<`CreateContractEventFilterReturnType`<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | Creates a Filter to retrieve event logs that can be used with [`getFilterChanges`](https://viem.sh/docs/actions/public/getFilterChanges) or [`getFilterLogs`](https://viem.sh/docs/actions/public/getFilterLogs). - Docs: https://viem.sh/docs/contract/createContractEventFilter **`Example`** `ts import { createPublicClient, http, parseAbi } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const filter = await client.createContractEventFilter({ abi: parseAbi(['event Transfer(address indexed, address indexed, uint256)']), }) ` | -| `client.createEventFilter` | (`args?`: `CreateEventFilterParameters`<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`, `_EventName`, `_Args`\>) => `Promise`<\{ [K in keyof Filter<"event", TAbiEvents, \_EventName, \_Args, TStrict, TFromBlock, TToBlock\>]: Filter<"event", TAbiEvents, ... 4 more ..., TToBlock\>[K]; }\> | Creates a [`Filter`](https://viem.sh/docs/glossary/types#filter) to listen for new events that can be used with [`getFilterChanges`](https://viem.sh/docs/actions/public/getFilterChanges). - Docs: https://viem.sh/docs/actions/public/createEventFilter - JSON-RPC Methods: [`eth_newFilter`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_newfilter) **`Example`** `ts import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const filter = await client.createEventFilter({ address: '0xfba3912ca04dd458c843e2ee08967fc04f3579c2', }) ` | -| `client.createPendingTransactionFilter` | () => `Promise`<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn` ; `type`: `"transaction"` }\> | Creates a Filter to listen for new pending transaction hashes that can be used with [`getFilterChanges`](https://viem.sh/docs/actions/public/getFilterChanges). - Docs: https://viem.sh/docs/actions/public/createPendingTransactionFilter - JSON-RPC Methods: [`eth_newPendingTransactionFilter`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_newpendingtransactionfilter) **`Example`** `ts import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const filter = await client.createPendingTransactionFilter() // { id: "0x345a6572337856574a76364e457a4366", type: 'transaction' } ` | -| `client.estimateContractGas` | (`args`: `EstimateContractGasParameters`<`abi`, `functionName`, `args`, `TChain`\>) => `Promise`<`bigint`\> | Estimates the gas required to successfully execute a contract write function call. - Docs: https://viem.sh/docs/contract/estimateContractGas **`Remarks`** Internally, uses a [Public Client](https://viem.sh/docs/clients/public) to call the [`estimateGas` action](https://viem.sh/docs/actions/public/estimateGas) with [ABI-encoded `data`](https://viem.sh/docs/contract/encodeFunctionData). **`Example`** `ts import { createPublicClient, http, parseAbi } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const gas = await client.estimateContractGas({ address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2', abi: parseAbi(['function mint() public']), functionName: 'mint', account: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266', }) ` | -| `client.estimateFeesPerGas` | (`args?`: `EstimateFeesPerGasParameters`<`undefined` \| `Chain`, `TChainOverride`, `TType`\>) => `Promise`<`EstimateFeesPerGasReturnType`\> | Returns an estimate for the fees per gas for a transaction to be included in the next block. - Docs: https://viem.sh/docs/actions/public/estimateFeesPerGas **`Example`** `ts import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const maxPriorityFeePerGas = await client.estimateFeesPerGas() // { maxFeePerGas: ..., maxPriorityFeePerGas: ... } ` | -| `client.estimateGas` | (`args`: `EstimateGasParameters`<`undefined` \| `Chain`\>) => `Promise`<`bigint`\> | Estimates the gas necessary to complete a transaction without submitting it to the network. - Docs: https://viem.sh/docs/actions/public/estimateGas - JSON-RPC Methods: [`eth_estimateGas`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_estimategas) **`Example`** `ts import { createPublicClient, http, parseEther } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const gasEstimate = await client.estimateGas({ account: '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e', to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8', value: parseEther('1'), }) ` | -| `client.estimateMaxPriorityFeePerGas` | (`args?`: \{ `chain`: `null` \| `TChainOverride` }) => `Promise`<`bigint`\> | Returns an estimate for the max priority fee per gas (in wei) for a transaction to be included in the next block. - Docs: https://viem.sh/docs/actions/public/estimateMaxPriorityFeePerGas **`Example`** `ts import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const maxPriorityFeePerGas = await client.estimateMaxPriorityFeePerGas() // 10000000n ` | -| `client.extend` | (`fn`: (`client`: `Client`<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, `PublicActions`<`Transport`, `undefined` \| `Chain`\>\>) => `client`) => `Client`<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, \{ [K in keyof client]: client[K]; } & `PublicActions`<`Transport`, `undefined` \| `Chain`\>\> | - | -| `client.getBalance` | (`args`: `GetBalanceParameters`) => `Promise`<`bigint`\> | Returns the balance of an address in wei. - Docs: https://viem.sh/docs/actions/public/getBalance - JSON-RPC Methods: [`eth_getBalance`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_getbalance) **`Remarks`** You can convert the balance to ether units with [`formatEther`](https://viem.sh/docs/utilities/formatEther). `ts const balance = await getBalance(client, { address: '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e', blockTag: 'safe' }) const balanceAsEther = formatEther(balance) // "6.942" ` **`Example`** `ts import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const balance = await client.getBalance({ address: '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e', }) // 10000000000000000000000n (wei) ` | -| `client.getBlobBaseFee` | () => `Promise`<`bigint`\> | Returns the base fee per blob gas in wei. - Docs: https://viem.sh/docs/actions/public/getBlobBaseFee - JSON-RPC Methods: [`eth_blobBaseFee`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_blobBaseFee) **`Example`** `ts import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' import { getBlobBaseFee } from 'viem/public' const client = createPublicClient({ chain: mainnet, transport: http(), }) const blobBaseFee = await client.getBlobBaseFee() ` | -| `client.getBlock` | (`args?`: `GetBlockParameters`<`TIncludeTransactions`, `TBlockTag`\>) => `Promise`<\{ number: TBlockTag extends "pending" ? null : bigint; nonce: TBlockTag extends "pending" ? null : \`0x$\{string}\`; hash: TBlockTag extends "pending" ? null : \`0x$\{string}\`; ... 22 more ...; transactions: TIncludeTransactions extends true ? (\{ ...; } \| ... 2 more ... \| \{ ...; })[] : \`0x$\{string}\`[]; }\> | Returns information about a block at a block number, hash, or tag. - Docs: https://viem.sh/docs/actions/public/getBlock - Examples: https://stackblitz.com/github/wevm/viem/tree/main/examples/blocks/fetching-blocks - JSON-RPC Methods: - Calls [`eth_getBlockByNumber`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_getblockbynumber) for `blockNumber` & `blockTag`. - Calls [`eth_getBlockByHash`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_getblockbyhash) for `blockHash`. **`Example`** `ts import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const block = await client.getBlock() ` | -| `client.getBlockNumber` | (`args?`: `GetBlockNumberParameters`) => `Promise`<`bigint`\> | Returns the number of the most recent block seen. - Docs: https://viem.sh/docs/actions/public/getBlockNumber - Examples: https://stackblitz.com/github/wevm/viem/tree/main/examples/blocks/fetching-blocks - JSON-RPC Methods: [`eth_blockNumber`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_blocknumber) **`Example`** `ts import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const blockNumber = await client.getBlockNumber() // 69420n ` | -| `client.getBlockTransactionCount` | (`args?`: `GetBlockTransactionCountParameters`) => `Promise`<`number`\> | Returns the number of Transactions at a block number, hash, or tag. - Docs: https://viem.sh/docs/actions/public/getBlockTransactionCount - JSON-RPC Methods: - Calls [`eth_getBlockTransactionCountByNumber`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_getblocktransactioncountbynumber) for `blockNumber` & `blockTag`. - Calls [`eth_getBlockTransactionCountByHash`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_getblocktransactioncountbyhash) for `blockHash`. **`Example`** `ts import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const count = await client.getBlockTransactionCount() ` | -| `client.getBytecode` | (`args`: `GetBytecodeParameters`) => `Promise`<`GetBytecodeReturnType`\> | Retrieves the bytecode at an address. - Docs: https://viem.sh/docs/contract/getBytecode - JSON-RPC Methods: [`eth_getCode`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_getcode) **`Example`** `ts import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const code = await client.getBytecode({ address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2', }) ` | -| `client.getChainId` | () => `Promise`<`number`\> | Returns the chain ID associated with the current network. - Docs: https://viem.sh/docs/actions/public/getChainId - JSON-RPC Methods: [`eth_chainId`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_chainid) **`Example`** `ts import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const chainId = await client.getChainId() // 1 ` | -| `client.getContractEvents` | (`args`: `GetContractEventsParameters`<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>) => `Promise`<`GetContractEventsReturnType`<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>\> | Returns a list of event logs emitted by a contract. - Docs: https://viem.sh/docs/actions/public/getContractEvents - JSON-RPC Methods: [`eth_getLogs`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_getlogs) **`Example`** `ts import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' import { wagmiAbi } from './abi' const client = createPublicClient({ chain: mainnet, transport: http(), }) const logs = await client.getContractEvents(client, { address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2', abi: wagmiAbi, eventName: 'Transfer' }) ` | -| `client.getEnsAddress` | (`args`: \{ blockNumber?: bigint \| undefined; blockTag?: BlockTag \| undefined; coinType?: number \| undefined; gatewayUrls?: string[] \| undefined; name: string; strict?: boolean \| undefined; universalResolverAddress?: \`0x$\{string}\` \| undefined; }) => `Promise`<`GetEnsAddressReturnType`\> | Gets address for ENS name. - Docs: https://viem.sh/docs/ens/actions/getEnsAddress - Examples: https://stackblitz.com/github/wevm/viem/tree/main/examples/ens **`Remarks`** Calls `resolve(bytes, bytes)` on ENS Universal Resolver Contract. Since ENS names prohibit certain forbidden characters (e.g. underscore) and have other validation rules, you likely want to [normalize ENS names](https://docs.ens.domains/contract-api-reference/name-processing#normalising-names) with [UTS-46 normalization](https://unicode.org/reports/tr46) before passing them to `getEnsAddress`. You can use the built-in [`normalize`](https://viem.sh/docs/ens/utilities/normalize) function for this. **`Example`** `ts import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' import { normalize } from 'viem/ens' const client = createPublicClient({ chain: mainnet, transport: http(), }) const ensAddress = await client.getEnsAddress({ name: normalize('wevm.eth'), }) // '0xd2135CfB216b74109775236E36d4b433F1DF507B' ` | -| `client.getEnsAvatar` | (`args`: \{ name: string; blockNumber?: bigint \| undefined; blockTag?: BlockTag \| undefined; gatewayUrls?: string[] \| undefined; strict?: boolean \| undefined; universalResolverAddress?: \`0x$\{string}\` \| undefined; assetGatewayUrls?: AssetGatewayUrls \| undefined; }) => `Promise`<`GetEnsAvatarReturnType`\> | Gets the avatar of an ENS name. - Docs: https://viem.sh/docs/ens/actions/getEnsAvatar - Examples: https://stackblitz.com/github/wevm/viem/tree/main/examples/ens **`Remarks`** Calls [`getEnsText`](https://viem.sh/docs/ens/actions/getEnsText) with `key` set to `'avatar'`. Since ENS names prohibit certain forbidden characters (e.g. underscore) and have other validation rules, you likely want to [normalize ENS names](https://docs.ens.domains/contract-api-reference/name-processing#normalising-names) with [UTS-46 normalization](https://unicode.org/reports/tr46) before passing them to `getEnsAddress`. You can use the built-in [`normalize`](https://viem.sh/docs/ens/utilities/normalize) function for this. **`Example`** `ts import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' import { normalize } from 'viem/ens' const client = createPublicClient({ chain: mainnet, transport: http(), }) const ensAvatar = await client.getEnsAvatar({ name: normalize('wevm.eth'), }) // 'https://ipfs.io/ipfs/Qma8mnp6xV3J2cRNf3mTth5C8nV11CAnceVinc3y8jSbio' ` | -| `client.getEnsName` | (`args`: \{ blockNumber?: bigint \| undefined; blockTag?: BlockTag \| undefined; address: \`0x$\{string}\`; gatewayUrls?: string[] \| undefined; strict?: boolean \| undefined; universalResolverAddress?: \`0x$\{string}\` \| undefined; }) => `Promise`<`GetEnsNameReturnType`\> | Gets primary name for specified address. - Docs: https://viem.sh/docs/ens/actions/getEnsName - Examples: https://stackblitz.com/github/wevm/viem/tree/main/examples/ens **`Remarks`** Calls `reverse(bytes)` on ENS Universal Resolver Contract to "reverse resolve" the address to the primary ENS name. **`Example`** `ts import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const ensName = await client.getEnsName({ address: '0xd2135CfB216b74109775236E36d4b433F1DF507B', }) // 'wevm.eth' ` | -| `client.getEnsResolver` | (`args`: \{ blockNumber?: bigint \| undefined; blockTag?: BlockTag \| undefined; name: string; universalResolverAddress?: \`0x$\{string}\` \| undefined; }) => `Promise`<\`0x$\{string}\`\> | Gets resolver for ENS name. - Docs: https://viem.sh/docs/ens/actions/getEnsResolver - Examples: https://stackblitz.com/github/wevm/viem/tree/main/examples/ens **`Remarks`** Calls `findResolver(bytes)` on ENS Universal Resolver Contract to retrieve the resolver of an ENS name. Since ENS names prohibit certain forbidden characters (e.g. underscore) and have other validation rules, you likely want to [normalize ENS names](https://docs.ens.domains/contract-api-reference/name-processing#normalising-names) with [UTS-46 normalization](https://unicode.org/reports/tr46) before passing them to `getEnsAddress`. You can use the built-in [`normalize`](https://viem.sh/docs/ens/utilities/normalize) function for this. **`Example`** `ts import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' import { normalize } from 'viem/ens' const client = createPublicClient({ chain: mainnet, transport: http(), }) const resolverAddress = await client.getEnsResolver({ name: normalize('wevm.eth'), }) // '0x4976fb03C32e5B8cfe2b6cCB31c09Ba78EBaBa41' ` | -| `client.getEnsText` | (`args`: \{ blockNumber?: bigint \| undefined; blockTag?: BlockTag \| undefined; name: string; gatewayUrls?: string[] \| undefined; key: string; strict?: boolean \| undefined; universalResolverAddress?: \`0x$\{string}\` \| undefined; }) => `Promise`<`GetEnsTextReturnType`\> | Gets a text record for specified ENS name. - Docs: https://viem.sh/docs/ens/actions/getEnsResolver - Examples: https://stackblitz.com/github/wevm/viem/tree/main/examples/ens **`Remarks`** Calls `resolve(bytes, bytes)` on ENS Universal Resolver Contract. Since ENS names prohibit certain forbidden characters (e.g. underscore) and have other validation rules, you likely want to [normalize ENS names](https://docs.ens.domains/contract-api-reference/name-processing#normalising-names) with [UTS-46 normalization](https://unicode.org/reports/tr46) before passing them to `getEnsAddress`. You can use the built-in [`normalize`](https://viem.sh/docs/ens/utilities/normalize) function for this. **`Example`** `ts import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' import { normalize } from 'viem/ens' const client = createPublicClient({ chain: mainnet, transport: http(), }) const twitterRecord = await client.getEnsText({ name: normalize('wevm.eth'), key: 'com.twitter', }) // 'wagmi_sh' ` | -| `client.getFeeHistory` | (`args`: `GetFeeHistoryParameters`) => `Promise`<`GetFeeHistoryReturnType`\> | Returns a collection of historical gas information. - Docs: https://viem.sh/docs/actions/public/getFeeHistory - JSON-RPC Methods: [`eth_feeHistory`](https://docs.alchemy.com/reference/eth-feehistory) **`Example`** `ts import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const feeHistory = await client.getFeeHistory({ blockCount: 4, rewardPercentiles: [25, 75], }) ` | -| `client.getFilterChanges` | (`args`: `GetFilterChangesParameters`<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`<`GetFilterChangesReturnType`<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | Returns a list of logs or hashes based on a [Filter](/docs/glossary/terms#filter) since the last time it was called. - Docs: https://viem.sh/docs/actions/public/getFilterChanges - JSON-RPC Methods: [`eth_getFilterChanges`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_getfilterchanges) **`Remarks`** A Filter can be created from the following actions: - [`createBlockFilter`](https://viem.sh/docs/actions/public/createBlockFilter) - [`createContractEventFilter`](https://viem.sh/docs/contract/createContractEventFilter) - [`createEventFilter`](https://viem.sh/docs/actions/public/createEventFilter) - [`createPendingTransactionFilter`](https://viem.sh/docs/actions/public/createPendingTransactionFilter) Depending on the type of filter, the return value will be different: - If the filter was created with `createContractEventFilter` or `createEventFilter`, it returns a list of logs. - If the filter was created with `createPendingTransactionFilter`, it returns a list of transaction hashes. - If the filter was created with `createBlockFilter`, it returns a list of block hashes. **`Example`** `ts // Blocks import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const filter = await client.createBlockFilter() const hashes = await client.getFilterChanges({ filter }) ` **`Example`** `ts // Contract Events import { createPublicClient, http, parseAbi } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const filter = await client.createContractEventFilter({ address: '0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48', abi: parseAbi(['event Transfer(address indexed, address indexed, uint256)']), eventName: 'Transfer', }) const logs = await client.getFilterChanges({ filter }) ` **`Example`** `ts // Raw Events import { createPublicClient, http, parseAbiItem } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const filter = await client.createEventFilter({ address: '0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48', event: parseAbiItem('event Transfer(address indexed, address indexed, uint256)'), }) const logs = await client.getFilterChanges({ filter }) ` **`Example`** `ts // Transactions import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const filter = await client.createPendingTransactionFilter() const hashes = await client.getFilterChanges({ filter }) ` | -| `client.getFilterLogs` | (`args`: `GetFilterLogsParameters`<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`<`GetFilterLogsReturnType`<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | Returns a list of event logs since the filter was created. - Docs: https://viem.sh/docs/actions/public/getFilterLogs - JSON-RPC Methods: [`eth_getFilterLogs`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_getfilterlogs) **`Remarks`** `getFilterLogs` is only compatible with **event filters**. **`Example`** `ts import { createPublicClient, http, parseAbiItem } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const filter = await client.createEventFilter({ address: '0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48', event: parseAbiItem('event Transfer(address indexed, address indexed, uint256)'), }) const logs = await client.getFilterLogs({ filter }) ` | -| `client.getGasPrice` | () => `Promise`<`bigint`\> | Returns the current price of gas (in wei). - Docs: https://viem.sh/docs/actions/public/getGasPrice - JSON-RPC Methods: [`eth_gasPrice`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_gasprice) **`Example`** `ts import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const gasPrice = await client.getGasPrice() ` | -| `client.getLogs` | (`args?`: `GetLogsParameters`<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`<`GetLogsReturnType`<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | Returns a list of event logs matching the provided parameters. - Docs: https://viem.sh/docs/actions/public/getLogs - Examples: https://stackblitz.com/github/wevm/viem/tree/main/examples/filters-and-logs/event-logs - JSON-RPC Methods: [`eth_getLogs`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_getlogs) **`Example`** `ts import { createPublicClient, http, parseAbiItem } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const logs = await client.getLogs() ` | -| `client.getProof` | (`args`: `GetProofParameters`) => `Promise`<`GetProofReturnType`\> | Returns the account and storage values of the specified account including the Merkle-proof. - Docs: https://viem.sh/docs/actions/public/getProof - JSON-RPC Methods: - Calls [`eth_getProof`](https://eips.ethereum.org/EIPS/eip-1186) **`Example`** `ts import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const block = await client.getProof({ address: '0x...', storageKeys: ['0x...'], }) ` | -| `client.getStorageAt` | (`args`: `GetStorageAtParameters`) => `Promise`<`GetStorageAtReturnType`\> | Returns the value from a storage slot at a given address. - Docs: https://viem.sh/docs/contract/getStorageAt - JSON-RPC Methods: [`eth_getStorageAt`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_getstorageat) **`Example`** `ts import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' import { getStorageAt } from 'viem/contract' const client = createPublicClient({ chain: mainnet, transport: http(), }) const code = await client.getStorageAt({ address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2', slot: toHex(0), }) ` | -| `client.getTransaction` | (`args`: `GetTransactionParameters`<`TBlockTag`\>) => `Promise`<\{ type: "legacy"; to: \`0x$\{string}\` \| null; from: \`0x$\{string}\`; gas: bigint; nonce: number; value: bigint; gasPrice: bigint; maxFeePerBlobGas?: undefined; maxFeePerGas?: undefined; maxPriorityFeePerGas?: undefined; ... 12 more ...; transactionIndex: (TBlockTag extends "pending" ? true : false) extends true ? null :... \| \{ type: "eip2930"; to: \`0x$\{string}\` \| null; from: \`0x$\{string}\`; gas: bigint; nonce: number; value: bigint; gasPrice: bigint; maxFeePerBlobGas?: undefined; maxFeePerGas?: undefined; maxPriorityFeePerGas?: undefined; ... 12 more ...; transactionIndex: (TBlockTag extends "pending" ? true : false) extends true ? null ... \| \{ type: "eip1559"; to: \`0x$\{string}\` \| null; from: \`0x$\{string}\`; gas: bigint; nonce: number; value: bigint; gasPrice?: undefined; maxFeePerBlobGas?: undefined; maxFeePerGas: bigint; maxPriorityFeePerGas: bigint; ... 12 more ...; transactionIndex: (TBlockTag extends "pending" ? true : false) extends true ? null : nu... \| \{ type: "eip4844"; to: \`0x$\{string}\` \| null; from: \`0x$\{string}\`; gas: bigint; nonce: number; value: bigint; gasPrice?: undefined; maxFeePerBlobGas: bigint; maxFeePerGas: bigint; maxPriorityFeePerGas: bigint; ... 12 more ...; transactionIndex: (TBlockTag extends "pending" ? true : false) extends true ? null : number...\> | Returns information about a [Transaction](https://viem.sh/docs/glossary/terms#transaction) given a hash or block identifier. - Docs: https://viem.sh/docs/actions/public/getTransaction - Example: https://stackblitz.com/github/wevm/viem/tree/main/examples/transactions/fetching-transactions - JSON-RPC Methods: [`eth_getTransactionByHash`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_getTransactionByHash) **`Example`** `ts import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const transaction = await client.getTransaction({ hash: '0x4ca7ee652d57678f26e887c149ab0735f41de37bcad58c9f6d3ed5824f15b74d', }) ` | -| `client.getTransactionConfirmations` | (`args`: `GetTransactionConfirmationsParameters`<`undefined` \| `Chain`\>) => `Promise`<`bigint`\> | Returns the number of blocks passed (confirmations) since the transaction was processed on a block. - Docs: https://viem.sh/docs/actions/public/getTransactionConfirmations - Example: https://stackblitz.com/github/wevm/viem/tree/main/examples/transactions/fetching-transactions - JSON-RPC Methods: [`eth_getTransactionConfirmations`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_getTransactionConfirmations) **`Example`** `ts import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const confirmations = await client.getTransactionConfirmations({ hash: '0x4ca7ee652d57678f26e887c149ab0735f41de37bcad58c9f6d3ed5824f15b74d', }) ` | -| `client.getTransactionCount` | (`args`: `GetTransactionCountParameters`) => `Promise`<`number`\> | Returns the number of [Transactions](https://viem.sh/docs/glossary/terms#transaction) an Account has broadcast / sent. - Docs: https://viem.sh/docs/actions/public/getTransactionCount - JSON-RPC Methods: [`eth_getTransactionCount`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_gettransactioncount) **`Example`** `ts import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const transactionCount = await client.getTransactionCount({ address: '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e', }) ` | -| `client.getTransactionReceipt` | (`args`: `GetTransactionReceiptParameters`) => `Promise`<`TransactionReceipt`\> | Returns the [Transaction Receipt](https://viem.sh/docs/glossary/terms#transaction-receipt) given a [Transaction](https://viem.sh/docs/glossary/terms#transaction) hash. - Docs: https://viem.sh/docs/actions/public/getTransactionReceipt - Example: https://stackblitz.com/github/wevm/viem/tree/main/examples/transactions/fetching-transactions - JSON-RPC Methods: [`eth_getTransactionReceipt`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_getTransactionReceipt) **`Example`** `ts import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const transactionReceipt = await client.getTransactionReceipt({ hash: '0x4ca7ee652d57678f26e887c149ab0735f41de37bcad58c9f6d3ed5824f15b74d', }) ` | -| `client.key` | `string` | A key for the client. | -| `client.multicall` | (`args`: `MulticallParameters`<`contracts`, `allowFailure`\>) => `Promise`<`MulticallReturnType`<`contracts`, `allowFailure`\>\> | Similar to [`readContract`](https://viem.sh/docs/contract/readContract), but batches up multiple functions on a contract in a single RPC call via the [`multicall3` contract](https://github.com/mds1/multicall). - Docs: https://viem.sh/docs/contract/multicall **`Example`** `ts import { createPublicClient, http, parseAbi } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const abi = parseAbi([ 'function balanceOf(address) view returns (uint256)', 'function totalSupply() view returns (uint256)', ]) const result = await client.multicall({ contracts: [ { address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2', abi, functionName: 'balanceOf', args: ['0xA0Cf798816D4b9b9866b5330EEa46a18382f251e'], }, { address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2', abi, functionName: 'totalSupply', }, ], }) // [{ result: 424122n, status: 'success' }, { result: 1000000n, status: 'success' }] ` | -| `client.name` | `string` | A name for the client. | -| `client.pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | -| `client.prepareTransactionRequest` | (`args`: `PrepareTransactionRequestParameters`<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`<\{ [K in keyof (UnionRequiredBy, "transactionRequest", TransactionRequest\>, "from"\> & (DeriveChain<...\> extends Chain ? \{ ...; } : \{ ...; }) & (DeriveAccount<...\> extends Account ? \{ ...; } : \{ ...; }), IsNever<...\> extends true ? un...\> | Prepares a transaction request for signing. - Docs: https://viem.sh/docs/actions/wallet/prepareTransactionRequest **`Example`** `ts import { createWalletClient, custom } from 'viem' import { mainnet } from 'viem/chains' const client = createWalletClient({ chain: mainnet, transport: custom(window.ethereum), }) const request = await client.prepareTransactionRequest({ account: '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e', to: '0x0000000000000000000000000000000000000000', value: 1n, }) ` **`Example`** `ts // Account Hoisting import { createWalletClient, http } from 'viem' import { privateKeyToAccount } from 'viem/accounts' import { mainnet } from 'viem/chains' const client = createWalletClient({ account: privateKeyToAccount('0x…'), chain: mainnet, transport: custom(window.ethereum), }) const request = await client.prepareTransactionRequest({ to: '0x0000000000000000000000000000000000000000', value: 1n, }) ` | -| `client.readContract` | (`args`: `ReadContractParameters`<`abi`, `functionName`, `args`\>) => `Promise`<`ReadContractReturnType`<`abi`, `functionName`, `args`\>\> | Calls a read-only function on a contract, and returns the response. - Docs: https://viem.sh/docs/contract/readContract - Examples: https://stackblitz.com/github/wevm/viem/tree/main/examples/contracts/reading-contracts **`Remarks`** A "read-only" function (constant function) on a Solidity contract is denoted by a `view` or `pure` keyword. They can only read the state of the contract, and cannot make any changes to it. Since read-only methods do not change the state of the contract, they do not require any gas to be executed, and can be called by any user without the need to pay for gas. Internally, uses a [Public Client](https://viem.sh/docs/clients/public) to call the [`call` action](https://viem.sh/docs/actions/public/call) with [ABI-encoded `data`](https://viem.sh/docs/contract/encodeFunctionData). **`Example`** `ts import { createPublicClient, http, parseAbi } from 'viem' import { mainnet } from 'viem/chains' import { readContract } from 'viem/contract' const client = createPublicClient({ chain: mainnet, transport: http(), }) const result = await client.readContract({ address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2', abi: parseAbi(['function balanceOf(address) view returns (uint256)']), functionName: 'balanceOf', args: ['0xA0Cf798816D4b9b9866b5330EEa46a18382f251e'], }) // 424122n ` | -| `client.request` | `EIP1193RequestFn`<`PublicRpcSchema`\> | Request function wrapped with friendly error handling | -| `client.sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`<\`0x$\{string}\`\> | Sends a **signed** transaction to the network - Docs: https://viem.sh/docs/actions/wallet/sendRawTransaction - JSON-RPC Method: [`eth_sendRawTransaction`](https://ethereum.github.io/execution-apis/api-documentation/) **`Example`** `ts import { createWalletClient, custom } from 'viem' import { mainnet } from 'viem/chains' import { sendRawTransaction } from 'viem/wallet' const client = createWalletClient({ chain: mainnet, transport: custom(window.ethereum), }) const hash = await client.sendRawTransaction({ serializedTransaction: '0x02f850018203118080825208808080c080a04012522854168b27e5dc3d5839bab5e6b39e1a0ffd343901ce1622e3d64b48f1a04e00902ae0502c4728cbf12156290df99c3ed7de85b1dbfe20b5c36931733a33' }) ` | -| `client.simulateContract` | (`args`: `SimulateContractParameters`<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `chainOverride`, `accountOverride`\>) => `Promise`<`SimulateContractReturnType`<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`, `accountOverride`\>\> | Simulates/validates a contract interaction. This is useful for retrieving **return data** and **revert reasons** of contract write functions. - Docs: https://viem.sh/docs/contract/simulateContract - Examples: https://stackblitz.com/github/wevm/viem/tree/main/examples/contracts/writing-to-contracts **`Remarks`** This function does not require gas to execute and _**does not**_ change the state of the blockchain. It is almost identical to [`readContract`](https://viem.sh/docs/contract/readContract), but also supports contract write functions. Internally, uses a [Public Client](https://viem.sh/docs/clients/public) to call the [`call` action](https://viem.sh/docs/actions/public/call) with [ABI-encoded `data`](https://viem.sh/docs/contract/encodeFunctionData). **`Example`** `ts import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const result = await client.simulateContract({ address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2', abi: parseAbi(['function mint(uint32) view returns (uint32)']), functionName: 'mint', args: ['69420'], account: '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e', }) ` | -| `client.transport` | `TransportConfig`<`string`, `EIP1193RequestFn`\> & `Record`<`string`, `any`\> | The RPC transport | -| `client.type` | `string` | The type of client. | -| `client.uid` | `string` | A unique ID for the client. | -| `client.uninstallFilter` | (`args`: `UninstallFilterParameters`) => `Promise`<`boolean`\> | Destroys a Filter that was created from one of the following Actions: - [`createBlockFilter`](https://viem.sh/docs/actions/public/createBlockFilter) - [`createEventFilter`](https://viem.sh/docs/actions/public/createEventFilter) - [`createPendingTransactionFilter`](https://viem.sh/docs/actions/public/createPendingTransactionFilter) - Docs: https://viem.sh/docs/actions/public/uninstallFilter - JSON-RPC Methods: [`eth_uninstallFilter`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_uninstallFilter) **`Example`** `ts import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' import { createPendingTransactionFilter, uninstallFilter } from 'viem/public' const filter = await client.createPendingTransactionFilter() const uninstalled = await client.uninstallFilter({ filter }) // true ` | -| `client.verifyMessage` | (`args`: `VerifyMessageParameters`) => `Promise`<`boolean`\> | - | -| `client.verifyTypedData` | (`args`: `VerifyTypedDataParameters`) => `Promise`<`boolean`\> | - | -| `client.waitForTransactionReceipt` | (`args`: `WaitForTransactionReceiptParameters`<`undefined` \| `Chain`\>) => `Promise`<`TransactionReceipt`\> | Waits for the [Transaction](https://viem.sh/docs/glossary/terms#transaction) to be included on a [Block](https://viem.sh/docs/glossary/terms#block) (one confirmation), and then returns the [Transaction Receipt](https://viem.sh/docs/glossary/terms#transaction-receipt). If the Transaction reverts, then the action will throw an error. - Docs: https://viem.sh/docs/actions/public/waitForTransactionReceipt - Example: https://stackblitz.com/github/wevm/viem/tree/main/examples/transactions/sending-transactions - JSON-RPC Methods: - Polls [`eth_getTransactionReceipt`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_getTransactionReceipt) on each block until it has been processed. - If a Transaction has been replaced: - Calls [`eth_getBlockByNumber`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_getblockbynumber) and extracts the transactions - Checks if one of the Transactions is a replacement - If so, calls [`eth_getTransactionReceipt`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_getTransactionReceipt). **`Remarks`** The `waitForTransactionReceipt` action additionally supports Replacement detection (e.g. sped up Transactions). Transactions can be replaced when a user modifies their transaction in their wallet (to speed up or cancel). Transactions are replaced when they are sent from the same nonce. There are 3 types of Transaction Replacement reasons: - `repriced`: The gas price has been modified (e.g. different `maxFeePerGas`) - `cancelled`: The Transaction has been cancelled (e.g. `value === 0n`) - `replaced`: The Transaction has been replaced (e.g. different `value` or `data`) **`Example`** `ts import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const transactionReceipt = await client.waitForTransactionReceipt({ hash: '0x4ca7ee652d57678f26e887c149ab0735f41de37bcad58c9f6d3ed5824f15b74d', }) ` | -| `client.watchBlockNumber` | (`args`: `WatchBlockNumberParameters`) => `WatchBlockNumberReturnType` | Watches and returns incoming block numbers. - Docs: https://viem.sh/docs/actions/public/watchBlockNumber - Examples: https://stackblitz.com/github/wevm/viem/tree/main/examples/blocks/watching-blocks - JSON-RPC Methods: - When `poll: true`, calls [`eth_blockNumber`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_blocknumber) on a polling interval. - When `poll: false` & WebSocket Transport, uses a WebSocket subscription via [`eth_subscribe`](https://docs.alchemy.com/reference/eth-subscribe-polygon) and the `"newHeads"` event. **`Example`** `ts import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const unwatch = await client.watchBlockNumber({ onBlockNumber: (blockNumber) => console.log(blockNumber), }) ` | -| `client.watchBlocks` | (`args`: `WatchBlocksParameters`<`Transport`, `undefined` \| `Chain`, `TIncludeTransactions`, `TBlockTag`\>) => `WatchBlocksReturnType` | Watches and returns information for incoming blocks. - Docs: https://viem.sh/docs/actions/public/watchBlocks - Examples: https://stackblitz.com/github/wevm/viem/tree/main/examples/blocks/watching-blocks - JSON-RPC Methods: - When `poll: true`, calls [`eth_getBlockByNumber`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_getBlockByNumber) on a polling interval. - When `poll: false` & WebSocket Transport, uses a WebSocket subscription via [`eth_subscribe`](https://docs.alchemy.com/reference/eth-subscribe-polygon) and the `"newHeads"` event. **`Example`** `ts import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const unwatch = await client.watchBlocks({ onBlock: (block) => console.log(block), }) ` | -| `client.watchContractEvent` | (`args`: `WatchContractEventParameters`<`TAbi`, `TEventName`, `TStrict`, `Transport`\>) => `WatchContractEventReturnType` | Watches and returns emitted contract event logs. - Docs: https://viem.sh/docs/contract/watchContractEvent **`Remarks`** This Action will batch up all the event logs found within the [`pollingInterval`](https://viem.sh/docs/contract/watchContractEvent#pollinginterval-optional), and invoke them via [`onLogs`](https://viem.sh/docs/contract/watchContractEvent#onLogs). `watchContractEvent` will attempt to create an [Event Filter](https://viem.sh/docs/contract/createContractEventFilter) and listen to changes to the Filter per polling interval, however, if the RPC Provider does not support Filters (e.g. `eth_newFilter`), then `watchContractEvent` will fall back to using [`getLogs`](https://viem.sh/docs/actions/public/getLogs) instead. **`Example`** `ts import { createPublicClient, http, parseAbi } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const unwatch = client.watchContractEvent({ address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2', abi: parseAbi(['event Transfer(address indexed from, address indexed to, uint256 value)']), eventName: 'Transfer', args: { from: '0xc961145a54C96E3aE9bAA048c4F4D6b04C13916b' }, onLogs: (logs) => console.log(logs), }) ` | -| `client.watchEvent` | (`args`: `WatchEventParameters`<`TAbiEvent`, `TAbiEvents`, `TStrict`, `Transport`\>) => `WatchEventReturnType` | Watches and returns emitted [Event Logs](https://viem.sh/docs/glossary/terms#event-log). - Docs: https://viem.sh/docs/actions/public/watchEvent - JSON-RPC Methods: - **RPC Provider supports `eth_newFilter`:** - Calls [`eth_newFilter`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_newfilter) to create a filter (called on initialize). - On a polling interval, it will call [`eth_getFilterChanges`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_getfilterchanges). - **RPC Provider does not support `eth_newFilter`:** - Calls [`eth_getLogs`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_getlogs) for each block between the polling interval. **`Remarks`** This Action will batch up all the Event Logs found within the [`pollingInterval`](https://viem.sh/docs/actions/public/watchEvent#pollinginterval-optional), and invoke them via [`onLogs`](https://viem.sh/docs/actions/public/watchEvent#onLogs). `watchEvent` will attempt to create an [Event Filter](https://viem.sh/docs/actions/public/createEventFilter) and listen to changes to the Filter per polling interval, however, if the RPC Provider does not support Filters (e.g. `eth_newFilter`), then `watchEvent` will fall back to using [`getLogs`](https://viem.sh/docs/actions/public/getLogs) instead. **`Example`** `ts import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const unwatch = client.watchEvent({ onLogs: (logs) => console.log(logs), }) ` | -| `client.watchPendingTransactions` | (`args`: `WatchPendingTransactionsParameters`<`Transport`\>) => `WatchPendingTransactionsReturnType` | Watches and returns pending transaction hashes. - Docs: https://viem.sh/docs/actions/public/watchPendingTransactions - JSON-RPC Methods: - When `poll: true` - Calls [`eth_newPendingTransactionFilter`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_newpendingtransactionfilter) to initialize the filter. - Calls [`eth_getFilterChanges`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_getFilterChanges) on a polling interval. - When `poll: false` & WebSocket Transport, uses a WebSocket subscription via [`eth_subscribe`](https://docs.alchemy.com/reference/eth-subscribe-polygon) and the `"newPendingTransactions"` event. **`Remarks`** This Action will batch up all the pending transactions found within the [`pollingInterval`](https://viem.sh/docs/actions/public/watchPendingTransactions#pollinginterval-optional), and invoke them via [`onTransactions`](https://viem.sh/docs/actions/public/watchPendingTransactions#ontransactions). **`Example`** `ts import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const unwatch = await client.watchPendingTransactions({ onTransactions: (hashes) => console.log(hashes), }) ` | -| `hash` | \`0x$\{string}\` | transaction hash returned from the transaction | - -#### Returns - -`Promise`<`ParserReturnType`\> - -returns a promise with the parsed data or errors - -**`Notice`** - -This method is a wrapper around basic viem utilties to parse ClaimStored(uint256 indexed claimID, string uri, uint256 totalUnits). - -#### Defined in - -[sdk/src/utils/txParser.ts:26](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/utils/txParser.ts#L26) - ---- - -### getFromIPFS - -▸ **getFromIPFS**(`cidOrIpfsUri`, `timeout?`): `Promise`<`unknown`\> - -Fetches data from IPFS using either the DWeb IPFS, NFT Storage, or the Web3Up gateway. - -This function attempts to fetch data from all gateways at the same time and returns on the first on to resolve. -If the data cannot be fetched from any gateway, it throws a `StorageError`. - -#### Parameters - -| Name | Type | Default value | Description | -| :------------- | :------- | :------------ | :---------------------------------------- | -| `cidOrIpfsUri` | `string` | `undefined` | The CID or IPFS URI of the data to fetch. | -| `timeout` | `number` | `10000` | - | - -#### Returns - -`Promise`<`unknown`\> - -The data fetched from IPFS. - -**`Throws`** - -Will throw a `StoragjeError` if the data cannot be fetched from either gateway. - -**`Async`** - -#### Defined in - -[sdk/src/utils/fetchers.ts:17](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/utils/fetchers.ts#L17) - ---- - -### getProofsFromAllowlist - -▸ **getProofsFromAllowlist**(`cidOrIpfsUri`, `account`): `Promise`<`undefined` \| \{ `proof`: `string`[] ; `root`: `string` = tree.root }\> - -This function retrieves proofs from an allowlist. - -It fetches a Merkle tree from IPFS using a given CID or IPFS URI, then iterates over the tree to find an account. -When the account is found, it generates a proof for that account and logs the account, index, and proof as debug. -It returns the proof and the root of the Merkle tree. - -#### Parameters - -| Name | Type | Description | -| :------------- | :--------------- | :------------------------------------------------- | -| `cidOrIpfsUri` | `string` | The CID or IPFS URI to fetch the Merkle tree from. | -| `account` | \`0x$\{string}\` | The account to find in the Merkle tree. | - -#### Returns - -`Promise`<`undefined` \| \{ `proof`: `string`[] ; `root`: `string` = tree.root }\> - -An object containing the proof for the account and the root of the Merkle tree. - -**`Throws`** - -Will throw an error if the Merkle tree cannot be fetched. - -**`Async`** - -#### Defined in - -[sdk/src/utils/allowlist.ts:43](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/utils/allowlist.ts#L43) - ---- - -### graphql - -▸ **graphql**(`source`): `unknown` - -The graphql function is used to parse GraphQL queries into a document that can be used by GraphQL clients. - -#### Parameters - -| Name | Type | -| :------- | :------- | -| `source` | `string` | - -#### Returns - -`unknown` - -**`Example`** - -```ts -const query = graphql( - ` - query GetUser($id: ID!) { - user(id: $id) { - name - } - } - `, -); -``` - -The query argument is unknown! -Please regenerate the types. - -#### Defined in - -[sdk/src/indexer/gql/gql.ts:32](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/indexer/gql/gql.ts#L32) - -▸ **graphql**(`source`): typeof `documents`[``"query ClaimsByOwner($owner: Bytes = \"\", $orderDirection: OrderDirection, $first: Int, $skip: Int) {\n claims(\n where: {owner: $owner}\n skip: $skip\n first: $first\n orderDirection: $orderDirection\n ) {\n contract\n tokenID\n creator\n id\n owner\n totalUnits\n uri\n }\n}\n\nquery RecentClaims($orderDirection: OrderDirection, $first: Int, $skip: Int) {\n claims(orderDirection: $orderDirection, orderBy: creation, first: $first) {\n contract\n tokenID\n creator\n id\n owner\n totalUnits\n uri\n }\n}\n\nquery ClaimById($id: ID!) {\n claim(id: $id) {\n contract\n tokenID\n creator\n id\n owner\n totalUnits\n uri\n }\n}"``] - -The graphql function is used to parse GraphQL queries into a document that can be used by GraphQL clients. - -#### Parameters - -| Name | Type | -| :------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `source` | `"query ClaimsByOwner($owner: Bytes = \"\", $orderDirection: OrderDirection, $first: Int, $skip: Int) {\n claims(\n where: {owner: $owner}\n skip: $skip\n first: $first\n orderDirection: $orderDirection\n ) {\n contract\n tokenID\n creator\n id\n owner\n totalUnits\n uri\n }\n}\n\nquery RecentClaims($orderDirection: OrderDirection, $first: Int, $skip: Int) {\n claims(orderDirection: $orderDirection, orderBy: creation, first: $first) {\n contract\n tokenID\n creator\n id\n owner\n totalUnits\n uri\n }\n}\n\nquery ClaimById($id: ID!) {\n claim(id: $id) {\n contract\n tokenID\n creator\n id\n owner\n totalUnits\n uri\n }\n}"` | - -#### Returns - -typeof `documents`[``"query ClaimsByOwner($owner: Bytes = \"\", $orderDirection: OrderDirection, $first: Int, $skip: Int) {\n claims(\n where: {owner: $owner}\n skip: $skip\n first: $first\n orderDirection: $orderDirection\n ) {\n contract\n tokenID\n creator\n id\n owner\n totalUnits\n uri\n }\n}\n\nquery RecentClaims($orderDirection: OrderDirection, $first: Int, $skip: Int) {\n claims(orderDirection: $orderDirection, orderBy: creation, first: $first) {\n contract\n tokenID\n creator\n id\n owner\n totalUnits\n uri\n }\n}\n\nquery ClaimById($id: ID!) {\n claim(id: $id) {\n contract\n tokenID\n creator\n id\n owner\n totalUnits\n uri\n }\n}"``] - -#### Defined in - -[sdk/src/indexer/gql/gql.ts:37](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/indexer/gql/gql.ts#L37) - -▸ **graphql**(`source`): typeof `documents`[``"query ClaimTokensByOwner($owner: Bytes = \"\", $orderDirection: OrderDirection, $first: Int, $skip: Int) {\n claimTokens(\n where: {owner: $owner}\n skip: $skip\n first: $first\n orderDirection: $orderDirection\n ) {\n id\n owner\n tokenID\n units\n claim {\n id\n creation\n uri\n totalUnits\n }\n }\n}\n\nquery ClaimTokensByClaim($claimId: String!, $orderDirection: OrderDirection, $first: Int, $skip: Int) {\n claimTokens(\n where: {claim: $claimId}\n skip: $skip\n first: $first\n orderDirection: $orderDirection\n ) {\n id\n owner\n tokenID\n units\n }\n}\n\nquery ClaimTokenById($claimTokenId: ID!) {\n claimToken(id: $claimTokenId) {\n id\n owner\n tokenID\n units\n claim {\n id\n creation\n uri\n totalUnits\n }\n }\n}"``] - -The graphql function is used to parse GraphQL queries into a document that can be used by GraphQL clients. - -#### Parameters - -| Name | Type | -| :------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `source` | `"query ClaimTokensByOwner($owner: Bytes = \"\", $orderDirection: OrderDirection, $first: Int, $skip: Int) {\n claimTokens(\n where: {owner: $owner}\n skip: $skip\n first: $first\n orderDirection: $orderDirection\n ) {\n id\n owner\n tokenID\n units\n claim {\n id\n creation\n uri\n totalUnits\n }\n }\n}\n\nquery ClaimTokensByClaim($claimId: String!, $orderDirection: OrderDirection, $first: Int, $skip: Int) {\n claimTokens(\n where: {claim: $claimId}\n skip: $skip\n first: $first\n orderDirection: $orderDirection\n ) {\n id\n owner\n tokenID\n units\n }\n}\n\nquery ClaimTokenById($claimTokenId: ID!) {\n claimToken(id: $claimTokenId) {\n id\n owner\n tokenID\n units\n claim {\n id\n creation\n uri\n totalUnits\n }\n }\n}"` | - -#### Returns - -typeof `documents`[``"query ClaimTokensByOwner($owner: Bytes = \"\", $orderDirection: OrderDirection, $first: Int, $skip: Int) {\n claimTokens(\n where: {owner: $owner}\n skip: $skip\n first: $first\n orderDirection: $orderDirection\n ) {\n id\n owner\n tokenID\n units\n claim {\n id\n creation\n uri\n totalUnits\n }\n }\n}\n\nquery ClaimTokensByClaim($claimId: String!, $orderDirection: OrderDirection, $first: Int, $skip: Int) {\n claimTokens(\n where: {claim: $claimId}\n skip: $skip\n first: $first\n orderDirection: $orderDirection\n ) {\n id\n owner\n tokenID\n units\n }\n}\n\nquery ClaimTokenById($claimTokenId: ID!) {\n claimToken(id: $claimTokenId) {\n id\n owner\n tokenID\n units\n claim {\n id\n creation\n uri\n totalUnits\n }\n }\n}"``] - -#### Defined in - -[sdk/src/indexer/gql/gql.ts:41](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/indexer/gql/gql.ts#L41) - ---- - -### handleContractError - -▸ **handleContractError**(`data`): [`ContractError`](classes/ContractError.md) - -#### Parameters - -| Name | Type | -| :----- | :--------------- | -| `data` | \`0x$\{string}\` | - -#### Returns - -[`ContractError`](classes/ContractError.md) - -#### Defined in - -[sdk/src/utils/errors.ts:39](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/utils/errors.ts#L39) - ---- - -### handleSdkError - -▸ **handleSdkError**(`err`): `void` - -Method to catch errors and log them - -#### Parameters - -| Name | Type | Description | -| :---- | :---------------------------------------------------- | :-------------------------------------------- | -| `err` | [`HypercertsSdkError`](modules.md#hypercertssdkerror) | Error to handle defined in HypercertsSdkError | - -#### Returns - -`void` - -#### Defined in - -[sdk/src/utils/errors.ts:22](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/utils/errors.ts#L22) - ---- - -### isFragmentReady - -▸ **isFragmentReady**<`TQuery`, `TFrag`\>(`queryNode`, `fragmentNode`, `data`): data is [TFrag] extends [Object] ? TKey extends string ? Object : never : never - -#### Type parameters - -| Name | -| :------- | -| `TQuery` | -| `TFrag` | - -#### Parameters - -| Name | Type | -| :------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `queryNode` | `DocumentTypeDecoration`<`TQuery`, `any`\> | -| `fragmentNode` | `TypedDocumentNode`<`TFrag`, \{ `[key: string]`: `any`; }\> | -| `data` | `undefined` \| `null` \| [`Incremental`<`TFrag`\>] extends [\{ ` $fragmentName?`: `TKey` }] ? `TKey` extends `string` ? \{ ` $fragmentRefs?`: \{ [key in string]: Object } } : `never` : `never` | - -#### Returns - -data is [TFrag] extends [Object] ? TKey extends string ? Object : never : never - -#### Defined in - -[sdk/src/indexer/gql/fragment-masking.ts:51](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/indexer/gql/fragment-masking.ts#L51) - ---- - -### makeFragmentData - -▸ **makeFragmentData**<`F`, `FT`\>(`data`, `_fragment`): [`FragmentType`](modules.md#fragmenttype)<`F`\> - -#### Type parameters - -| Name | Type | -| :--- | :---------------------------------------------- | -| `F` | extends `DocumentTypeDecoration`<`any`, `any`\> | -| `FT` | extends `any` | - -#### Parameters - -| Name | Type | -| :---------- | :--- | -| `data` | `FT` | -| `_fragment` | `F` | - -#### Returns - -[`FragmentType`](modules.md#fragmenttype)<`F`\> - -#### Defined in - -[sdk/src/indexer/gql/fragment-masking.ts:45](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/indexer/gql/fragment-masking.ts#L45) - ---- - -### parseAllowListEntriesToMerkleTree - -▸ **parseAllowListEntriesToMerkleTree**(`allowList`): `StandardMerkleTree`<`string`[]\> - -#### Parameters - -| Name | Type | -| :---------- | :---------------------------------------------- | -| `allowList` | [`AllowlistEntry`](modules.md#allowlistentry)[] | - -#### Returns - -`StandardMerkleTree`<`string`[]\> - -#### Defined in - -[sdk/src/utils/allowlist.ts:6](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/utils/allowlist.ts#L6) - ---- - -### parseClaimOrFractionId - -▸ **parseClaimOrFractionId**(`claimId`): `Object` - -#### Parameters - -| Name | Type | -| :-------- | :------- | -| `claimId` | `string` | - -#### Returns - -`Object` - -| Name | Type | -| :---------------- | :--------------- | -| `chainId` | `number` | -| `contractAddress` | \`0x$\{string}\` | -| `id` | `bigint` | - -#### Defined in - -[sdk/src/utils/parsing.ts:3](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/utils/parsing.ts#L3) - ---- - -### publicClientToProvider - -▸ **publicClientToProvider**(`publicClient`): `undefined` \| `FallbackProvider` \| `JsonRpcProvider` - -This function converts a `PublicClient` instance to an ethers.js `Provider` to faciliate compatibility between ethers and viem. - -It extracts the chain and transport from the `PublicClient` and creates a network object. -If no chain is found in the `PublicClient`, it logs a warning and stops the signature request. -If the transport type is "fallback", it creates a `FallbackProvider` with multiple transports. -Otherwise, it creates a `JsonRpcProvider` with a single transport. - -Ref: https://viem.sh/docs/ethers-migration.html - -#### Parameters - -| Name | Type | Description | -| :-------------------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `publicClient` | `Object` | The `PublicClient` instance to convert. | -| `publicClient.account` | `undefined` | The Account of the Client. | -| `publicClient.batch?` | `Object` | Flags for batch settings. | -| `publicClient.batch.multicall?` | `boolean` \| \{ batchSize?: number \| undefined; wait?: number \| undefined; } | Toggle to enable `eth_call` multicall aggregation. | -| `publicClient.cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | -| `publicClient.call` | (`parameters`: `CallParameters`<`undefined` \| `Chain`\>) => `Promise`<`CallReturnType`\> | Executes a new message call immediately without submitting a transaction to the network. - Docs: https://viem.sh/docs/actions/public/call - JSON-RPC Methods: [`eth_call`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_call) **`Example`** `ts import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const data = await client.call({ account: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266', data: '0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2', to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8', }) ` | -| `publicClient.ccipRead?` | `false` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | -| `publicClient.chain` | `undefined` \| `Chain` | Chain for the client. | -| `publicClient.createBlockFilter` | () => `Promise`<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn` ; `type`: `"block"` }\> | Creates a Filter to listen for new block hashes that can be used with [`getFilterChanges`](https://viem.sh/docs/actions/public/getFilterChanges). - Docs: https://viem.sh/docs/actions/public/createBlockFilter - JSON-RPC Methods: [`eth_newBlockFilter`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_newBlockFilter) **`Example`** `ts import { createPublicClient, createBlockFilter, http } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const filter = await createBlockFilter(client) // { id: "0x345a6572337856574a76364e457a4366", type: 'block' } ` | -| `publicClient.createContractEventFilter` | (`args`: `CreateContractEventFilterParameters`<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`<`CreateContractEventFilterReturnType`<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | Creates a Filter to retrieve event logs that can be used with [`getFilterChanges`](https://viem.sh/docs/actions/public/getFilterChanges) or [`getFilterLogs`](https://viem.sh/docs/actions/public/getFilterLogs). - Docs: https://viem.sh/docs/contract/createContractEventFilter **`Example`** `ts import { createPublicClient, http, parseAbi } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const filter = await client.createContractEventFilter({ abi: parseAbi(['event Transfer(address indexed, address indexed, uint256)']), }) ` | -| `publicClient.createEventFilter` | (`args?`: `CreateEventFilterParameters`<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`, `_EventName`, `_Args`\>) => `Promise`<\{ [K in keyof Filter<"event", TAbiEvents, \_EventName, \_Args, TStrict, TFromBlock, TToBlock\>]: Filter<"event", TAbiEvents, ... 4 more ..., TToBlock\>[K]; }\> | Creates a [`Filter`](https://viem.sh/docs/glossary/types#filter) to listen for new events that can be used with [`getFilterChanges`](https://viem.sh/docs/actions/public/getFilterChanges). - Docs: https://viem.sh/docs/actions/public/createEventFilter - JSON-RPC Methods: [`eth_newFilter`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_newfilter) **`Example`** `ts import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const filter = await client.createEventFilter({ address: '0xfba3912ca04dd458c843e2ee08967fc04f3579c2', }) ` | -| `publicClient.createPendingTransactionFilter` | () => `Promise`<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn` ; `type`: `"transaction"` }\> | Creates a Filter to listen for new pending transaction hashes that can be used with [`getFilterChanges`](https://viem.sh/docs/actions/public/getFilterChanges). - Docs: https://viem.sh/docs/actions/public/createPendingTransactionFilter - JSON-RPC Methods: [`eth_newPendingTransactionFilter`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_newpendingtransactionfilter) **`Example`** `ts import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const filter = await client.createPendingTransactionFilter() // { id: "0x345a6572337856574a76364e457a4366", type: 'transaction' } ` | -| `publicClient.estimateContractGas` | (`args`: `EstimateContractGasParameters`<`abi`, `functionName`, `args`, `TChain`\>) => `Promise`<`bigint`\> | Estimates the gas required to successfully execute a contract write function call. - Docs: https://viem.sh/docs/contract/estimateContractGas **`Remarks`** Internally, uses a [Public Client](https://viem.sh/docs/clients/public) to call the [`estimateGas` action](https://viem.sh/docs/actions/public/estimateGas) with [ABI-encoded `data`](https://viem.sh/docs/contract/encodeFunctionData). **`Example`** `ts import { createPublicClient, http, parseAbi } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const gas = await client.estimateContractGas({ address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2', abi: parseAbi(['function mint() public']), functionName: 'mint', account: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266', }) ` | -| `publicClient.estimateFeesPerGas` | (`args?`: `EstimateFeesPerGasParameters`<`undefined` \| `Chain`, `TChainOverride`, `TType`\>) => `Promise`<`EstimateFeesPerGasReturnType`\> | Returns an estimate for the fees per gas for a transaction to be included in the next block. - Docs: https://viem.sh/docs/actions/public/estimateFeesPerGas **`Example`** `ts import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const maxPriorityFeePerGas = await client.estimateFeesPerGas() // { maxFeePerGas: ..., maxPriorityFeePerGas: ... } ` | -| `publicClient.estimateGas` | (`args`: `EstimateGasParameters`<`undefined` \| `Chain`\>) => `Promise`<`bigint`\> | Estimates the gas necessary to complete a transaction without submitting it to the network. - Docs: https://viem.sh/docs/actions/public/estimateGas - JSON-RPC Methods: [`eth_estimateGas`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_estimategas) **`Example`** `ts import { createPublicClient, http, parseEther } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const gasEstimate = await client.estimateGas({ account: '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e', to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8', value: parseEther('1'), }) ` | -| `publicClient.estimateMaxPriorityFeePerGas` | (`args?`: \{ `chain`: `null` \| `TChainOverride` }) => `Promise`<`bigint`\> | Returns an estimate for the max priority fee per gas (in wei) for a transaction to be included in the next block. - Docs: https://viem.sh/docs/actions/public/estimateMaxPriorityFeePerGas **`Example`** `ts import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const maxPriorityFeePerGas = await client.estimateMaxPriorityFeePerGas() // 10000000n ` | -| `publicClient.extend` | (`fn`: (`client`: `Client`<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, `PublicActions`<`Transport`, `undefined` \| `Chain`\>\>) => `client`) => `Client`<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, \{ [K in keyof client]: client[K]; } & `PublicActions`<`Transport`, `undefined` \| `Chain`\>\> | - | -| `publicClient.getBalance` | (`args`: `GetBalanceParameters`) => `Promise`<`bigint`\> | Returns the balance of an address in wei. - Docs: https://viem.sh/docs/actions/public/getBalance - JSON-RPC Methods: [`eth_getBalance`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_getbalance) **`Remarks`** You can convert the balance to ether units with [`formatEther`](https://viem.sh/docs/utilities/formatEther). `ts const balance = await getBalance(client, { address: '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e', blockTag: 'safe' }) const balanceAsEther = formatEther(balance) // "6.942" ` **`Example`** `ts import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const balance = await client.getBalance({ address: '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e', }) // 10000000000000000000000n (wei) ` | -| `publicClient.getBlobBaseFee` | () => `Promise`<`bigint`\> | Returns the base fee per blob gas in wei. - Docs: https://viem.sh/docs/actions/public/getBlobBaseFee - JSON-RPC Methods: [`eth_blobBaseFee`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_blobBaseFee) **`Example`** `ts import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' import { getBlobBaseFee } from 'viem/public' const client = createPublicClient({ chain: mainnet, transport: http(), }) const blobBaseFee = await client.getBlobBaseFee() ` | -| `publicClient.getBlock` | (`args?`: `GetBlockParameters`<`TIncludeTransactions`, `TBlockTag`\>) => `Promise`<\{ number: TBlockTag extends "pending" ? null : bigint; nonce: TBlockTag extends "pending" ? null : \`0x$\{string}\`; hash: TBlockTag extends "pending" ? null : \`0x$\{string}\`; ... 22 more ...; transactions: TIncludeTransactions extends true ? (\{ ...; } \| ... 2 more ... \| \{ ...; })[] : \`0x$\{string}\`[]; }\> | Returns information about a block at a block number, hash, or tag. - Docs: https://viem.sh/docs/actions/public/getBlock - Examples: https://stackblitz.com/github/wevm/viem/tree/main/examples/blocks/fetching-blocks - JSON-RPC Methods: - Calls [`eth_getBlockByNumber`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_getblockbynumber) for `blockNumber` & `blockTag`. - Calls [`eth_getBlockByHash`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_getblockbyhash) for `blockHash`. **`Example`** `ts import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const block = await client.getBlock() ` | -| `publicClient.getBlockNumber` | (`args?`: `GetBlockNumberParameters`) => `Promise`<`bigint`\> | Returns the number of the most recent block seen. - Docs: https://viem.sh/docs/actions/public/getBlockNumber - Examples: https://stackblitz.com/github/wevm/viem/tree/main/examples/blocks/fetching-blocks - JSON-RPC Methods: [`eth_blockNumber`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_blocknumber) **`Example`** `ts import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const blockNumber = await client.getBlockNumber() // 69420n ` | -| `publicClient.getBlockTransactionCount` | (`args?`: `GetBlockTransactionCountParameters`) => `Promise`<`number`\> | Returns the number of Transactions at a block number, hash, or tag. - Docs: https://viem.sh/docs/actions/public/getBlockTransactionCount - JSON-RPC Methods: - Calls [`eth_getBlockTransactionCountByNumber`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_getblocktransactioncountbynumber) for `blockNumber` & `blockTag`. - Calls [`eth_getBlockTransactionCountByHash`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_getblocktransactioncountbyhash) for `blockHash`. **`Example`** `ts import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const count = await client.getBlockTransactionCount() ` | -| `publicClient.getBytecode` | (`args`: `GetBytecodeParameters`) => `Promise`<`GetBytecodeReturnType`\> | Retrieves the bytecode at an address. - Docs: https://viem.sh/docs/contract/getBytecode - JSON-RPC Methods: [`eth_getCode`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_getcode) **`Example`** `ts import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const code = await client.getBytecode({ address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2', }) ` | -| `publicClient.getChainId` | () => `Promise`<`number`\> | Returns the chain ID associated with the current network. - Docs: https://viem.sh/docs/actions/public/getChainId - JSON-RPC Methods: [`eth_chainId`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_chainid) **`Example`** `ts import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const chainId = await client.getChainId() // 1 ` | -| `publicClient.getContractEvents` | (`args`: `GetContractEventsParameters`<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>) => `Promise`<`GetContractEventsReturnType`<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>\> | Returns a list of event logs emitted by a contract. - Docs: https://viem.sh/docs/actions/public/getContractEvents - JSON-RPC Methods: [`eth_getLogs`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_getlogs) **`Example`** `ts import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' import { wagmiAbi } from './abi' const client = createPublicClient({ chain: mainnet, transport: http(), }) const logs = await client.getContractEvents(client, { address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2', abi: wagmiAbi, eventName: 'Transfer' }) ` | -| `publicClient.getEnsAddress` | (`args`: \{ blockNumber?: bigint \| undefined; blockTag?: BlockTag \| undefined; coinType?: number \| undefined; gatewayUrls?: string[] \| undefined; name: string; strict?: boolean \| undefined; universalResolverAddress?: \`0x$\{string}\` \| undefined; }) => `Promise`<`GetEnsAddressReturnType`\> | Gets address for ENS name. - Docs: https://viem.sh/docs/ens/actions/getEnsAddress - Examples: https://stackblitz.com/github/wevm/viem/tree/main/examples/ens **`Remarks`** Calls `resolve(bytes, bytes)` on ENS Universal Resolver Contract. Since ENS names prohibit certain forbidden characters (e.g. underscore) and have other validation rules, you likely want to [normalize ENS names](https://docs.ens.domains/contract-api-reference/name-processing#normalising-names) with [UTS-46 normalization](https://unicode.org/reports/tr46) before passing them to `getEnsAddress`. You can use the built-in [`normalize`](https://viem.sh/docs/ens/utilities/normalize) function for this. **`Example`** `ts import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' import { normalize } from 'viem/ens' const client = createPublicClient({ chain: mainnet, transport: http(), }) const ensAddress = await client.getEnsAddress({ name: normalize('wevm.eth'), }) // '0xd2135CfB216b74109775236E36d4b433F1DF507B' ` | -| `publicClient.getEnsAvatar` | (`args`: \{ name: string; blockNumber?: bigint \| undefined; blockTag?: BlockTag \| undefined; gatewayUrls?: string[] \| undefined; strict?: boolean \| undefined; universalResolverAddress?: \`0x$\{string}\` \| undefined; assetGatewayUrls?: AssetGatewayUrls \| undefined; }) => `Promise`<`GetEnsAvatarReturnType`\> | Gets the avatar of an ENS name. - Docs: https://viem.sh/docs/ens/actions/getEnsAvatar - Examples: https://stackblitz.com/github/wevm/viem/tree/main/examples/ens **`Remarks`** Calls [`getEnsText`](https://viem.sh/docs/ens/actions/getEnsText) with `key` set to `'avatar'`. Since ENS names prohibit certain forbidden characters (e.g. underscore) and have other validation rules, you likely want to [normalize ENS names](https://docs.ens.domains/contract-api-reference/name-processing#normalising-names) with [UTS-46 normalization](https://unicode.org/reports/tr46) before passing them to `getEnsAddress`. You can use the built-in [`normalize`](https://viem.sh/docs/ens/utilities/normalize) function for this. **`Example`** `ts import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' import { normalize } from 'viem/ens' const client = createPublicClient({ chain: mainnet, transport: http(), }) const ensAvatar = await client.getEnsAvatar({ name: normalize('wevm.eth'), }) // 'https://ipfs.io/ipfs/Qma8mnp6xV3J2cRNf3mTth5C8nV11CAnceVinc3y8jSbio' ` | -| `publicClient.getEnsName` | (`args`: \{ blockNumber?: bigint \| undefined; blockTag?: BlockTag \| undefined; address: \`0x$\{string}\`; gatewayUrls?: string[] \| undefined; strict?: boolean \| undefined; universalResolverAddress?: \`0x$\{string}\` \| undefined; }) => `Promise`<`GetEnsNameReturnType`\> | Gets primary name for specified address. - Docs: https://viem.sh/docs/ens/actions/getEnsName - Examples: https://stackblitz.com/github/wevm/viem/tree/main/examples/ens **`Remarks`** Calls `reverse(bytes)` on ENS Universal Resolver Contract to "reverse resolve" the address to the primary ENS name. **`Example`** `ts import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const ensName = await client.getEnsName({ address: '0xd2135CfB216b74109775236E36d4b433F1DF507B', }) // 'wevm.eth' ` | -| `publicClient.getEnsResolver` | (`args`: \{ blockNumber?: bigint \| undefined; blockTag?: BlockTag \| undefined; name: string; universalResolverAddress?: \`0x$\{string}\` \| undefined; }) => `Promise`<\`0x$\{string}\`\> | Gets resolver for ENS name. - Docs: https://viem.sh/docs/ens/actions/getEnsResolver - Examples: https://stackblitz.com/github/wevm/viem/tree/main/examples/ens **`Remarks`** Calls `findResolver(bytes)` on ENS Universal Resolver Contract to retrieve the resolver of an ENS name. Since ENS names prohibit certain forbidden characters (e.g. underscore) and have other validation rules, you likely want to [normalize ENS names](https://docs.ens.domains/contract-api-reference/name-processing#normalising-names) with [UTS-46 normalization](https://unicode.org/reports/tr46) before passing them to `getEnsAddress`. You can use the built-in [`normalize`](https://viem.sh/docs/ens/utilities/normalize) function for this. **`Example`** `ts import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' import { normalize } from 'viem/ens' const client = createPublicClient({ chain: mainnet, transport: http(), }) const resolverAddress = await client.getEnsResolver({ name: normalize('wevm.eth'), }) // '0x4976fb03C32e5B8cfe2b6cCB31c09Ba78EBaBa41' ` | -| `publicClient.getEnsText` | (`args`: \{ blockNumber?: bigint \| undefined; blockTag?: BlockTag \| undefined; name: string; gatewayUrls?: string[] \| undefined; key: string; strict?: boolean \| undefined; universalResolverAddress?: \`0x$\{string}\` \| undefined; }) => `Promise`<`GetEnsTextReturnType`\> | Gets a text record for specified ENS name. - Docs: https://viem.sh/docs/ens/actions/getEnsResolver - Examples: https://stackblitz.com/github/wevm/viem/tree/main/examples/ens **`Remarks`** Calls `resolve(bytes, bytes)` on ENS Universal Resolver Contract. Since ENS names prohibit certain forbidden characters (e.g. underscore) and have other validation rules, you likely want to [normalize ENS names](https://docs.ens.domains/contract-api-reference/name-processing#normalising-names) with [UTS-46 normalization](https://unicode.org/reports/tr46) before passing them to `getEnsAddress`. You can use the built-in [`normalize`](https://viem.sh/docs/ens/utilities/normalize) function for this. **`Example`** `ts import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' import { normalize } from 'viem/ens' const client = createPublicClient({ chain: mainnet, transport: http(), }) const twitterRecord = await client.getEnsText({ name: normalize('wevm.eth'), key: 'com.twitter', }) // 'wagmi_sh' ` | -| `publicClient.getFeeHistory` | (`args`: `GetFeeHistoryParameters`) => `Promise`<`GetFeeHistoryReturnType`\> | Returns a collection of historical gas information. - Docs: https://viem.sh/docs/actions/public/getFeeHistory - JSON-RPC Methods: [`eth_feeHistory`](https://docs.alchemy.com/reference/eth-feehistory) **`Example`** `ts import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const feeHistory = await client.getFeeHistory({ blockCount: 4, rewardPercentiles: [25, 75], }) ` | -| `publicClient.getFilterChanges` | (`args`: `GetFilterChangesParameters`<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`<`GetFilterChangesReturnType`<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | Returns a list of logs or hashes based on a [Filter](/docs/glossary/terms#filter) since the last time it was called. - Docs: https://viem.sh/docs/actions/public/getFilterChanges - JSON-RPC Methods: [`eth_getFilterChanges`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_getfilterchanges) **`Remarks`** A Filter can be created from the following actions: - [`createBlockFilter`](https://viem.sh/docs/actions/public/createBlockFilter) - [`createContractEventFilter`](https://viem.sh/docs/contract/createContractEventFilter) - [`createEventFilter`](https://viem.sh/docs/actions/public/createEventFilter) - [`createPendingTransactionFilter`](https://viem.sh/docs/actions/public/createPendingTransactionFilter) Depending on the type of filter, the return value will be different: - If the filter was created with `createContractEventFilter` or `createEventFilter`, it returns a list of logs. - If the filter was created with `createPendingTransactionFilter`, it returns a list of transaction hashes. - If the filter was created with `createBlockFilter`, it returns a list of block hashes. **`Example`** `ts // Blocks import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const filter = await client.createBlockFilter() const hashes = await client.getFilterChanges({ filter }) ` **`Example`** `ts // Contract Events import { createPublicClient, http, parseAbi } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const filter = await client.createContractEventFilter({ address: '0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48', abi: parseAbi(['event Transfer(address indexed, address indexed, uint256)']), eventName: 'Transfer', }) const logs = await client.getFilterChanges({ filter }) ` **`Example`** `ts // Raw Events import { createPublicClient, http, parseAbiItem } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const filter = await client.createEventFilter({ address: '0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48', event: parseAbiItem('event Transfer(address indexed, address indexed, uint256)'), }) const logs = await client.getFilterChanges({ filter }) ` **`Example`** `ts // Transactions import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const filter = await client.createPendingTransactionFilter() const hashes = await client.getFilterChanges({ filter }) ` | -| `publicClient.getFilterLogs` | (`args`: `GetFilterLogsParameters`<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`<`GetFilterLogsReturnType`<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | Returns a list of event logs since the filter was created. - Docs: https://viem.sh/docs/actions/public/getFilterLogs - JSON-RPC Methods: [`eth_getFilterLogs`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_getfilterlogs) **`Remarks`** `getFilterLogs` is only compatible with **event filters**. **`Example`** `ts import { createPublicClient, http, parseAbiItem } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const filter = await client.createEventFilter({ address: '0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48', event: parseAbiItem('event Transfer(address indexed, address indexed, uint256)'), }) const logs = await client.getFilterLogs({ filter }) ` | -| `publicClient.getGasPrice` | () => `Promise`<`bigint`\> | Returns the current price of gas (in wei). - Docs: https://viem.sh/docs/actions/public/getGasPrice - JSON-RPC Methods: [`eth_gasPrice`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_gasprice) **`Example`** `ts import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const gasPrice = await client.getGasPrice() ` | -| `publicClient.getLogs` | (`args?`: `GetLogsParameters`<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`<`GetLogsReturnType`<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | Returns a list of event logs matching the provided parameters. - Docs: https://viem.sh/docs/actions/public/getLogs - Examples: https://stackblitz.com/github/wevm/viem/tree/main/examples/filters-and-logs/event-logs - JSON-RPC Methods: [`eth_getLogs`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_getlogs) **`Example`** `ts import { createPublicClient, http, parseAbiItem } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const logs = await client.getLogs() ` | -| `publicClient.getProof` | (`args`: `GetProofParameters`) => `Promise`<`GetProofReturnType`\> | Returns the account and storage values of the specified account including the Merkle-proof. - Docs: https://viem.sh/docs/actions/public/getProof - JSON-RPC Methods: - Calls [`eth_getProof`](https://eips.ethereum.org/EIPS/eip-1186) **`Example`** `ts import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const block = await client.getProof({ address: '0x...', storageKeys: ['0x...'], }) ` | -| `publicClient.getStorageAt` | (`args`: `GetStorageAtParameters`) => `Promise`<`GetStorageAtReturnType`\> | Returns the value from a storage slot at a given address. - Docs: https://viem.sh/docs/contract/getStorageAt - JSON-RPC Methods: [`eth_getStorageAt`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_getstorageat) **`Example`** `ts import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' import { getStorageAt } from 'viem/contract' const client = createPublicClient({ chain: mainnet, transport: http(), }) const code = await client.getStorageAt({ address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2', slot: toHex(0), }) ` | -| `publicClient.getTransaction` | (`args`: `GetTransactionParameters`<`TBlockTag`\>) => `Promise`<\{ type: "legacy"; to: \`0x$\{string}\` \| null; from: \`0x$\{string}\`; gas: bigint; nonce: number; value: bigint; gasPrice: bigint; maxFeePerBlobGas?: undefined; maxFeePerGas?: undefined; maxPriorityFeePerGas?: undefined; ... 12 more ...; transactionIndex: (TBlockTag extends "pending" ? true : false) extends true ? null :... \| \{ type: "eip2930"; to: \`0x$\{string}\` \| null; from: \`0x$\{string}\`; gas: bigint; nonce: number; value: bigint; gasPrice: bigint; maxFeePerBlobGas?: undefined; maxFeePerGas?: undefined; maxPriorityFeePerGas?: undefined; ... 12 more ...; transactionIndex: (TBlockTag extends "pending" ? true : false) extends true ? null ... \| \{ type: "eip1559"; to: \`0x$\{string}\` \| null; from: \`0x$\{string}\`; gas: bigint; nonce: number; value: bigint; gasPrice?: undefined; maxFeePerBlobGas?: undefined; maxFeePerGas: bigint; maxPriorityFeePerGas: bigint; ... 12 more ...; transactionIndex: (TBlockTag extends "pending" ? true : false) extends true ? null : nu... \| \{ type: "eip4844"; to: \`0x$\{string}\` \| null; from: \`0x$\{string}\`; gas: bigint; nonce: number; value: bigint; gasPrice?: undefined; maxFeePerBlobGas: bigint; maxFeePerGas: bigint; maxPriorityFeePerGas: bigint; ... 12 more ...; transactionIndex: (TBlockTag extends "pending" ? true : false) extends true ? null : number...\> | Returns information about a [Transaction](https://viem.sh/docs/glossary/terms#transaction) given a hash or block identifier. - Docs: https://viem.sh/docs/actions/public/getTransaction - Example: https://stackblitz.com/github/wevm/viem/tree/main/examples/transactions/fetching-transactions - JSON-RPC Methods: [`eth_getTransactionByHash`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_getTransactionByHash) **`Example`** `ts import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const transaction = await client.getTransaction({ hash: '0x4ca7ee652d57678f26e887c149ab0735f41de37bcad58c9f6d3ed5824f15b74d', }) ` | -| `publicClient.getTransactionConfirmations` | (`args`: `GetTransactionConfirmationsParameters`<`undefined` \| `Chain`\>) => `Promise`<`bigint`\> | Returns the number of blocks passed (confirmations) since the transaction was processed on a block. - Docs: https://viem.sh/docs/actions/public/getTransactionConfirmations - Example: https://stackblitz.com/github/wevm/viem/tree/main/examples/transactions/fetching-transactions - JSON-RPC Methods: [`eth_getTransactionConfirmations`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_getTransactionConfirmations) **`Example`** `ts import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const confirmations = await client.getTransactionConfirmations({ hash: '0x4ca7ee652d57678f26e887c149ab0735f41de37bcad58c9f6d3ed5824f15b74d', }) ` | -| `publicClient.getTransactionCount` | (`args`: `GetTransactionCountParameters`) => `Promise`<`number`\> | Returns the number of [Transactions](https://viem.sh/docs/glossary/terms#transaction) an Account has broadcast / sent. - Docs: https://viem.sh/docs/actions/public/getTransactionCount - JSON-RPC Methods: [`eth_getTransactionCount`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_gettransactioncount) **`Example`** `ts import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const transactionCount = await client.getTransactionCount({ address: '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e', }) ` | -| `publicClient.getTransactionReceipt` | (`args`: `GetTransactionReceiptParameters`) => `Promise`<`TransactionReceipt`\> | Returns the [Transaction Receipt](https://viem.sh/docs/glossary/terms#transaction-receipt) given a [Transaction](https://viem.sh/docs/glossary/terms#transaction) hash. - Docs: https://viem.sh/docs/actions/public/getTransactionReceipt - Example: https://stackblitz.com/github/wevm/viem/tree/main/examples/transactions/fetching-transactions - JSON-RPC Methods: [`eth_getTransactionReceipt`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_getTransactionReceipt) **`Example`** `ts import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const transactionReceipt = await client.getTransactionReceipt({ hash: '0x4ca7ee652d57678f26e887c149ab0735f41de37bcad58c9f6d3ed5824f15b74d', }) ` | -| `publicClient.key` | `string` | A key for the client. | -| `publicClient.multicall` | (`args`: `MulticallParameters`<`contracts`, `allowFailure`\>) => `Promise`<`MulticallReturnType`<`contracts`, `allowFailure`\>\> | Similar to [`readContract`](https://viem.sh/docs/contract/readContract), but batches up multiple functions on a contract in a single RPC call via the [`multicall3` contract](https://github.com/mds1/multicall). - Docs: https://viem.sh/docs/contract/multicall **`Example`** `ts import { createPublicClient, http, parseAbi } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const abi = parseAbi([ 'function balanceOf(address) view returns (uint256)', 'function totalSupply() view returns (uint256)', ]) const result = await client.multicall({ contracts: [ { address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2', abi, functionName: 'balanceOf', args: ['0xA0Cf798816D4b9b9866b5330EEa46a18382f251e'], }, { address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2', abi, functionName: 'totalSupply', }, ], }) // [{ result: 424122n, status: 'success' }, { result: 1000000n, status: 'success' }] ` | -| `publicClient.name` | `string` | A name for the client. | -| `publicClient.pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | -| `publicClient.prepareTransactionRequest` | (`args`: `PrepareTransactionRequestParameters`<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`<\{ [K in keyof (UnionRequiredBy, "transactionRequest", TransactionRequest\>, "from"\> & (DeriveChain<...\> extends Chain ? \{ ...; } : \{ ...; }) & (DeriveAccount<...\> extends Account ? \{ ...; } : \{ ...; }), IsNever<...\> extends true ? un...\> | Prepares a transaction request for signing. - Docs: https://viem.sh/docs/actions/wallet/prepareTransactionRequest **`Example`** `ts import { createWalletClient, custom } from 'viem' import { mainnet } from 'viem/chains' const client = createWalletClient({ chain: mainnet, transport: custom(window.ethereum), }) const request = await client.prepareTransactionRequest({ account: '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e', to: '0x0000000000000000000000000000000000000000', value: 1n, }) ` **`Example`** `ts // Account Hoisting import { createWalletClient, http } from 'viem' import { privateKeyToAccount } from 'viem/accounts' import { mainnet } from 'viem/chains' const client = createWalletClient({ account: privateKeyToAccount('0x…'), chain: mainnet, transport: custom(window.ethereum), }) const request = await client.prepareTransactionRequest({ to: '0x0000000000000000000000000000000000000000', value: 1n, }) ` | -| `publicClient.readContract` | (`args`: `ReadContractParameters`<`abi`, `functionName`, `args`\>) => `Promise`<`ReadContractReturnType`<`abi`, `functionName`, `args`\>\> | Calls a read-only function on a contract, and returns the response. - Docs: https://viem.sh/docs/contract/readContract - Examples: https://stackblitz.com/github/wevm/viem/tree/main/examples/contracts/reading-contracts **`Remarks`** A "read-only" function (constant function) on a Solidity contract is denoted by a `view` or `pure` keyword. They can only read the state of the contract, and cannot make any changes to it. Since read-only methods do not change the state of the contract, they do not require any gas to be executed, and can be called by any user without the need to pay for gas. Internally, uses a [Public Client](https://viem.sh/docs/clients/public) to call the [`call` action](https://viem.sh/docs/actions/public/call) with [ABI-encoded `data`](https://viem.sh/docs/contract/encodeFunctionData). **`Example`** `ts import { createPublicClient, http, parseAbi } from 'viem' import { mainnet } from 'viem/chains' import { readContract } from 'viem/contract' const client = createPublicClient({ chain: mainnet, transport: http(), }) const result = await client.readContract({ address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2', abi: parseAbi(['function balanceOf(address) view returns (uint256)']), functionName: 'balanceOf', args: ['0xA0Cf798816D4b9b9866b5330EEa46a18382f251e'], }) // 424122n ` | -| `publicClient.request` | `EIP1193RequestFn`<`PublicRpcSchema`\> | Request function wrapped with friendly error handling | -| `publicClient.sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`<\`0x$\{string}\`\> | Sends a **signed** transaction to the network - Docs: https://viem.sh/docs/actions/wallet/sendRawTransaction - JSON-RPC Method: [`eth_sendRawTransaction`](https://ethereum.github.io/execution-apis/api-documentation/) **`Example`** `ts import { createWalletClient, custom } from 'viem' import { mainnet } from 'viem/chains' import { sendRawTransaction } from 'viem/wallet' const client = createWalletClient({ chain: mainnet, transport: custom(window.ethereum), }) const hash = await client.sendRawTransaction({ serializedTransaction: '0x02f850018203118080825208808080c080a04012522854168b27e5dc3d5839bab5e6b39e1a0ffd343901ce1622e3d64b48f1a04e00902ae0502c4728cbf12156290df99c3ed7de85b1dbfe20b5c36931733a33' }) ` | -| `publicClient.simulateContract` | (`args`: `SimulateContractParameters`<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `chainOverride`, `accountOverride`\>) => `Promise`<`SimulateContractReturnType`<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`, `accountOverride`\>\> | Simulates/validates a contract interaction. This is useful for retrieving **return data** and **revert reasons** of contract write functions. - Docs: https://viem.sh/docs/contract/simulateContract - Examples: https://stackblitz.com/github/wevm/viem/tree/main/examples/contracts/writing-to-contracts **`Remarks`** This function does not require gas to execute and _**does not**_ change the state of the blockchain. It is almost identical to [`readContract`](https://viem.sh/docs/contract/readContract), but also supports contract write functions. Internally, uses a [Public Client](https://viem.sh/docs/clients/public) to call the [`call` action](https://viem.sh/docs/actions/public/call) with [ABI-encoded `data`](https://viem.sh/docs/contract/encodeFunctionData). **`Example`** `ts import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const result = await client.simulateContract({ address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2', abi: parseAbi(['function mint(uint32) view returns (uint32)']), functionName: 'mint', args: ['69420'], account: '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e', }) ` | -| `publicClient.transport` | `TransportConfig`<`string`, `EIP1193RequestFn`\> & `Record`<`string`, `any`\> | The RPC transport | -| `publicClient.type` | `string` | The type of client. | -| `publicClient.uid` | `string` | A unique ID for the client. | -| `publicClient.uninstallFilter` | (`args`: `UninstallFilterParameters`) => `Promise`<`boolean`\> | Destroys a Filter that was created from one of the following Actions: - [`createBlockFilter`](https://viem.sh/docs/actions/public/createBlockFilter) - [`createEventFilter`](https://viem.sh/docs/actions/public/createEventFilter) - [`createPendingTransactionFilter`](https://viem.sh/docs/actions/public/createPendingTransactionFilter) - Docs: https://viem.sh/docs/actions/public/uninstallFilter - JSON-RPC Methods: [`eth_uninstallFilter`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_uninstallFilter) **`Example`** `ts import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' import { createPendingTransactionFilter, uninstallFilter } from 'viem/public' const filter = await client.createPendingTransactionFilter() const uninstalled = await client.uninstallFilter({ filter }) // true ` | -| `publicClient.verifyMessage` | (`args`: `VerifyMessageParameters`) => `Promise`<`boolean`\> | - | -| `publicClient.verifyTypedData` | (`args`: `VerifyTypedDataParameters`) => `Promise`<`boolean`\> | - | -| `publicClient.waitForTransactionReceipt` | (`args`: `WaitForTransactionReceiptParameters`<`undefined` \| `Chain`\>) => `Promise`<`TransactionReceipt`\> | Waits for the [Transaction](https://viem.sh/docs/glossary/terms#transaction) to be included on a [Block](https://viem.sh/docs/glossary/terms#block) (one confirmation), and then returns the [Transaction Receipt](https://viem.sh/docs/glossary/terms#transaction-receipt). If the Transaction reverts, then the action will throw an error. - Docs: https://viem.sh/docs/actions/public/waitForTransactionReceipt - Example: https://stackblitz.com/github/wevm/viem/tree/main/examples/transactions/sending-transactions - JSON-RPC Methods: - Polls [`eth_getTransactionReceipt`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_getTransactionReceipt) on each block until it has been processed. - If a Transaction has been replaced: - Calls [`eth_getBlockByNumber`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_getblockbynumber) and extracts the transactions - Checks if one of the Transactions is a replacement - If so, calls [`eth_getTransactionReceipt`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_getTransactionReceipt). **`Remarks`** The `waitForTransactionReceipt` action additionally supports Replacement detection (e.g. sped up Transactions). Transactions can be replaced when a user modifies their transaction in their wallet (to speed up or cancel). Transactions are replaced when they are sent from the same nonce. There are 3 types of Transaction Replacement reasons: - `repriced`: The gas price has been modified (e.g. different `maxFeePerGas`) - `cancelled`: The Transaction has been cancelled (e.g. `value === 0n`) - `replaced`: The Transaction has been replaced (e.g. different `value` or `data`) **`Example`** `ts import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const transactionReceipt = await client.waitForTransactionReceipt({ hash: '0x4ca7ee652d57678f26e887c149ab0735f41de37bcad58c9f6d3ed5824f15b74d', }) ` | -| `publicClient.watchBlockNumber` | (`args`: `WatchBlockNumberParameters`) => `WatchBlockNumberReturnType` | Watches and returns incoming block numbers. - Docs: https://viem.sh/docs/actions/public/watchBlockNumber - Examples: https://stackblitz.com/github/wevm/viem/tree/main/examples/blocks/watching-blocks - JSON-RPC Methods: - When `poll: true`, calls [`eth_blockNumber`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_blocknumber) on a polling interval. - When `poll: false` & WebSocket Transport, uses a WebSocket subscription via [`eth_subscribe`](https://docs.alchemy.com/reference/eth-subscribe-polygon) and the `"newHeads"` event. **`Example`** `ts import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const unwatch = await client.watchBlockNumber({ onBlockNumber: (blockNumber) => console.log(blockNumber), }) ` | -| `publicClient.watchBlocks` | (`args`: `WatchBlocksParameters`<`Transport`, `undefined` \| `Chain`, `TIncludeTransactions`, `TBlockTag`\>) => `WatchBlocksReturnType` | Watches and returns information for incoming blocks. - Docs: https://viem.sh/docs/actions/public/watchBlocks - Examples: https://stackblitz.com/github/wevm/viem/tree/main/examples/blocks/watching-blocks - JSON-RPC Methods: - When `poll: true`, calls [`eth_getBlockByNumber`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_getBlockByNumber) on a polling interval. - When `poll: false` & WebSocket Transport, uses a WebSocket subscription via [`eth_subscribe`](https://docs.alchemy.com/reference/eth-subscribe-polygon) and the `"newHeads"` event. **`Example`** `ts import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const unwatch = await client.watchBlocks({ onBlock: (block) => console.log(block), }) ` | -| `publicClient.watchContractEvent` | (`args`: `WatchContractEventParameters`<`TAbi`, `TEventName`, `TStrict`, `Transport`\>) => `WatchContractEventReturnType` | Watches and returns emitted contract event logs. - Docs: https://viem.sh/docs/contract/watchContractEvent **`Remarks`** This Action will batch up all the event logs found within the [`pollingInterval`](https://viem.sh/docs/contract/watchContractEvent#pollinginterval-optional), and invoke them via [`onLogs`](https://viem.sh/docs/contract/watchContractEvent#onLogs). `watchContractEvent` will attempt to create an [Event Filter](https://viem.sh/docs/contract/createContractEventFilter) and listen to changes to the Filter per polling interval, however, if the RPC Provider does not support Filters (e.g. `eth_newFilter`), then `watchContractEvent` will fall back to using [`getLogs`](https://viem.sh/docs/actions/public/getLogs) instead. **`Example`** `ts import { createPublicClient, http, parseAbi } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const unwatch = client.watchContractEvent({ address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2', abi: parseAbi(['event Transfer(address indexed from, address indexed to, uint256 value)']), eventName: 'Transfer', args: { from: '0xc961145a54C96E3aE9bAA048c4F4D6b04C13916b' }, onLogs: (logs) => console.log(logs), }) ` | -| `publicClient.watchEvent` | (`args`: `WatchEventParameters`<`TAbiEvent`, `TAbiEvents`, `TStrict`, `Transport`\>) => `WatchEventReturnType` | Watches and returns emitted [Event Logs](https://viem.sh/docs/glossary/terms#event-log). - Docs: https://viem.sh/docs/actions/public/watchEvent - JSON-RPC Methods: - **RPC Provider supports `eth_newFilter`:** - Calls [`eth_newFilter`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_newfilter) to create a filter (called on initialize). - On a polling interval, it will call [`eth_getFilterChanges`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_getfilterchanges). - **RPC Provider does not support `eth_newFilter`:** - Calls [`eth_getLogs`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_getlogs) for each block between the polling interval. **`Remarks`** This Action will batch up all the Event Logs found within the [`pollingInterval`](https://viem.sh/docs/actions/public/watchEvent#pollinginterval-optional), and invoke them via [`onLogs`](https://viem.sh/docs/actions/public/watchEvent#onLogs). `watchEvent` will attempt to create an [Event Filter](https://viem.sh/docs/actions/public/createEventFilter) and listen to changes to the Filter per polling interval, however, if the RPC Provider does not support Filters (e.g. `eth_newFilter`), then `watchEvent` will fall back to using [`getLogs`](https://viem.sh/docs/actions/public/getLogs) instead. **`Example`** `ts import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const unwatch = client.watchEvent({ onLogs: (logs) => console.log(logs), }) ` | -| `publicClient.watchPendingTransactions` | (`args`: `WatchPendingTransactionsParameters`<`Transport`\>) => `WatchPendingTransactionsReturnType` | Watches and returns pending transaction hashes. - Docs: https://viem.sh/docs/actions/public/watchPendingTransactions - JSON-RPC Methods: - When `poll: true` - Calls [`eth_newPendingTransactionFilter`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_newpendingtransactionfilter) to initialize the filter. - Calls [`eth_getFilterChanges`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_getFilterChanges) on a polling interval. - When `poll: false` & WebSocket Transport, uses a WebSocket subscription via [`eth_subscribe`](https://docs.alchemy.com/reference/eth-subscribe-polygon) and the `"newPendingTransactions"` event. **`Remarks`** This Action will batch up all the pending transactions found within the [`pollingInterval`](https://viem.sh/docs/actions/public/watchPendingTransactions#pollinginterval-optional), and invoke them via [`onTransactions`](https://viem.sh/docs/actions/public/watchPendingTransactions#ontransactions). **`Example`** `ts import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const unwatch = await client.watchPendingTransactions({ onTransactions: (hashes) => console.log(hashes), }) ` | - -#### Returns - -`undefined` \| `FallbackProvider` \| `JsonRpcProvider` - -An ethers.js `Provider` instance, or `undefined` if no chain is found in the `PublicClient`. - -#### Defined in - -[sdk/src/utils/adapters.ts:19](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/utils/adapters.ts#L19) - ---- - -### uploadAllowlist - -▸ **uploadAllowlist**(`req`, `config?`): `Promise`<`ResponseData`<\{ `cid`: `string` }\>\> - -Uploads an allowlist to the API. - -#### Parameters - -| Name | Type | Description | -| :-------- | :------------------------------------------------------------ | :----------------------------------------------------------------------------------------------------------------- | -| `req` | `AllowListPostRequest` | The request body containing the allowlist and total units. The allowList should be a stringified Merkle tree dump. | -| `config?` | [`StorageConfigOverrides`](modules.md#storageconfigoverrides) | An optional configuration object. | - -#### Returns - -`Promise`<`ResponseData`<\{ `cid`: `string` }\>\> - -The response data from the API. - -#### Defined in - -[sdk/src/utils/apis.ts:52](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/utils/apis.ts#L52) - ---- - -### uploadMetadata - -▸ **uploadMetadata**(`metadata`, `config?`): `Promise`<`ResponseData`<\{ `cid`: `string` }\>\> - -Uploads metadata to the API. - -#### Parameters - -| Name | Type | Description | -| :--------- | :------------------------------------------------------------ | :--------------------------------------------------------------------------------------- | -| `metadata` | [`HypercertMetadata`](interfaces/HypercertMetadata.md) | The metadata to upload. Should be an object that conforms to the HypercertMetadata type. | -| `config?` | [`StorageConfigOverrides`](modules.md#storageconfigoverrides) | An optional configuration object. | - -#### Returns - -`Promise`<`ResponseData`<\{ `cid`: `string` }\>\> - -The response data from the API. - -#### Defined in - -[sdk/src/utils/apis.ts:34](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/utils/apis.ts#L34) - ---- - -### useFragment - -▸ **useFragment**<`TType`\>(`_documentNode`, `fragmentType`): `TType` - -#### Type parameters - -| Name | -| :------ | -| `TType` | - -#### Parameters - -| Name | Type | -| :-------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------- | -| `_documentNode` | `DocumentTypeDecoration`<`TType`, `any`\> | -| `fragmentType` | [`TType`] extends [\{ ` $fragmentName?`: `TKey` }] ? `TKey` extends `string` ? \{ ` $fragmentRefs?`: \{ [key in string]: TType } } : `never` : `never` | - -#### Returns - -`TType` - -#### Defined in - -[sdk/src/indexer/gql/fragment-masking.ts:18](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/indexer/gql/fragment-masking.ts#L18) - -▸ **useFragment**<`TType`\>(`_documentNode`, `fragmentType`): `TType` \| `null` \| `undefined` - -#### Type parameters - -| Name | -| :------ | -| `TType` | - -#### Parameters - -| Name | Type | -| :-------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `_documentNode` | `DocumentTypeDecoration`<`TType`, `any`\> | -| `fragmentType` | `undefined` \| `null` \| [`TType`] extends [\{ ` $fragmentName?`: `TKey` }] ? `TKey` extends `string` ? \{ ` $fragmentRefs?`: \{ [key in string]: TType } } : `never` : `never` | - -#### Returns - -`TType` \| `null` \| `undefined` - -#### Defined in - -[sdk/src/indexer/gql/fragment-masking.ts:23](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/indexer/gql/fragment-masking.ts#L23) - -▸ **useFragment**<`TType`\>(`_documentNode`, `fragmentType`): `ReadonlyArray`<`TType`\> - -#### Type parameters - -| Name | -| :------ | -| `TType` | - -#### Parameters - -| Name | Type | -| :-------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `_documentNode` | `DocumentTypeDecoration`<`TType`, `any`\> | -| `fragmentType` | readonly [`TType`] extends [\{ ` $fragmentName?`: `TKey` }] ? `TKey` extends `string` ? \{ ` $fragmentRefs?`: \{ [key in string]: TType } } : `never` : `never`[] | - -#### Returns - -`ReadonlyArray`<`TType`\> - -#### Defined in - -[sdk/src/indexer/gql/fragment-masking.ts:28](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/indexer/gql/fragment-masking.ts#L28) - -▸ **useFragment**<`TType`\>(`_documentNode`, `fragmentType`): `ReadonlyArray`<`TType`\> \| `null` \| `undefined` - -#### Type parameters - -| Name | -| :------ | -| `TType` | - -#### Parameters - -| Name | Type | -| :-------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `_documentNode` | `DocumentTypeDecoration`<`TType`, `any`\> | -| `fragmentType` | `undefined` \| `null` \| readonly [`TType`] extends [\{ ` $fragmentName?`: `TKey` }] ? `TKey` extends `string` ? \{ ` $fragmentRefs?`: \{ [key in string]: TType } } : `never` : `never`[] | - -#### Returns - -`ReadonlyArray`<`TType`\> \| `null` \| `undefined` - -#### Defined in - -[sdk/src/indexer/gql/fragment-masking.ts:33](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/indexer/gql/fragment-masking.ts#L33) - ---- - -### validateAllowlist - -▸ **validateAllowlist**(`data`, `units`): `ValidationResult` - -Validates an array of allowlist entries. - -This function checks that the total units in the allowlist match the expected total units, that the total units are greater than 0, -and that all addresses in the allowlist are valid Ethereum addresses. It returns an object that includes a validity flag and any errors that occurred during validation. - -#### Parameters - -| Name | Type | Description | -| :------ | :---------------------------------------------- | :---------------------------------------------------------------------------------------------------------------- | -| `data` | [`AllowlistEntry`](modules.md#allowlistentry)[] | The allowlist entries to validate. Each entry should be an object that includes an address and a number of units. | -| `units` | `bigint` | The expected total units in the allowlist. | - -#### Returns - -`ValidationResult` - -An object that includes a validity flag and any errors that occurred during validation. The keys in the errors object are the names of the invalid properties, and the values are the error messages. - -#### Defined in - -[sdk/src/validator/index.ts:108](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/validator/index.ts#L108) - ---- - -### validateClaimData - -▸ **validateClaimData**(`data`): `ValidationResult` - -Validates Hypercert claim data. - -This function uses the AJV library to validate the claim data. It first retrieves the schema for the claim data, -then validates the data against the schema. If the schema is not found, it returns an error. If the data does not -conform to the schema, it returns the validation errors. If the data is valid, it returns a success message. - -#### Parameters - -| Name | Type | Description | -| :----- | :-------- | :------------------------------------------------------------------------------------------------- | -| `data` | `unknown` | The claim data to validate. This should be an object that conforms to the HypercertClaimdata type. | - -#### Returns - -`ValidationResult` - -An object that includes a validity flag and any errors that occurred during validation. - -#### Defined in - -[sdk/src/validator/index.ts:77](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/validator/index.ts#L77) - ---- - -### validateDuplicateEvaluationData - -▸ **validateDuplicateEvaluationData**(`data`): `ValidationResult` - -Validates duplicate evaluation data. - -This function uses the AJV library to validate the duplicate evaluation data. It first retrieves the schema for the duplicate evaluation data, -then validates the data against the schema. If the schema is not found, it returns an error. If the data does not -conform to the schema, it returns the validation errors. If the data is valid, it returns a success message. - -#### Parameters - -| Name | Type | Description | -| :----- | :--------------------------------------------------------- | :----------------------------------------------------------------------------------------------------------------- | -| `data` | [`DuplicateEvaluation`](interfaces/DuplicateEvaluation.md) | The duplicate evaluation data to validate. This should be an object that conforms to the DuplicateEvaluation type. | - -#### Returns - -`ValidationResult` - -An object that includes a validity flag and any errors that occurred during validation. - -#### Defined in - -[sdk/src/validator/index.ts:143](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/validator/index.ts#L143) - ---- - -### validateMetaData - -▸ **validateMetaData**(`data`): `ValidationResult` - -Validates Hypercert metadata. - -This function uses the AJV library to validate the metadata. It first retrieves the schema for the metadata, -then validates the data against the schema. If the schema is not found, it returns an error. If the data does not -conform to the schema, it returns the validation errors. If the data is valid, it returns a success message. - -#### Parameters - -| Name | Type | Description | -| :----- | :-------- | :---------------------------------------------------------------------------------------------- | -| `data` | `unknown` | The metadata to validate. This should be an object that conforms to the HypercertMetadata type. | - -#### Returns - -`ValidationResult` - -An object that includes a validity flag and any errors that occurred during validation. - -#### Defined in - -[sdk/src/validator/index.ts:46](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/validator/index.ts#L46) - ---- - -### validateSimpleTextEvaluationData - -▸ **validateSimpleTextEvaluationData**(`data`): `ValidationResult` - -Validates simple text evaluation data against a predefined schema. - -This function uses the AJV library to validate the simple text evaluation data. It first retrieves the schema for the simple text evaluation data, -then validates the data against the schema. If the schema is not found, it returns an error. If the data does not -conform to the schema, it returns the validation errors. If the data is valid, it returns a success message. - -#### Parameters - -| Name | Type | Description | -| :----- | :----------------------------------------------------------- | :-------------------------------------------------------------------------------------------------------------------- | -| `data` | [`SimpleTextEvaluation`](interfaces/SimpleTextEvaluation.md) | The simple text evaluation data to validate. This should be an object that conforms to the SimpleTextEvaluation type. | - -#### Returns - -`ValidationResult` - -An object that includes a validity flag and any errors that occurred during validation. - -#### Defined in - -[sdk/src/validator/index.ts:173](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/validator/index.ts#L173) - ---- - -### verifyMerkleProof - -▸ **verifyMerkleProof**(`root`, `signerAddress`, `units`, `proof`): `void` - -Verifies a Merkle proof for a given root, signer address, units, and proof. - -This function first checks if the signer address is a valid Ethereum address. If it's not, it throws a `MintingError`. -It then verifies the Merkle proof using the `StandardMerkleTree.verify` method. If the verification fails, it throws a `MintingError`. - -#### Parameters - -| Name | Type | Description | -| :-------------- | :--------- | :----------------------------- | -| `root` | `string` | The root of the Merkle tree. | -| `signerAddress` | `string` | The signer's Ethereum address. | -| `units` | `bigint` | The number of units. | -| `proof` | `string`[] | The Merkle proof to verify. | - -#### Returns - -`void` - -**`Throws`** - -Will throw a `MintingError` if the signer address is invalid or if the Merkle proof verification fails. - -#### Defined in - -[sdk/src/validator/index.ts:205](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/validator/index.ts#L205) - ---- - -### verifyMerkleProofs - -▸ **verifyMerkleProofs**(`roots`, `signerAddress`, `units`, `proofs`): `void` - -Verifies multiple Merkle proofs for given roots, a signer address, units, and proofs. - -This function first checks if the lengths of the roots, units, and proofs arrays are equal. If they're not, it throws a `MintingError`. -It then iterates over the arrays and verifies each Merkle proof using the `verifyMerkleProof` function. If any verification fails, it throws a `MintingError`. - -#### Parameters - -| Name | Type | Description | -| :-------------- | :----------- | :----------------------------- | -| `roots` | `string`[] | The roots of the Merkle trees. | -| `signerAddress` | `string` | The signer's Ethereum address. | -| `units` | `bigint`[] | The numbers of units. | -| `proofs` | `string`[][] | The Merkle proofs to verify. | - -#### Returns - -`void` - -**`Throws`** - -Will throw a `MintingError` if the lengths of the input arrays are not equal or if any Merkle proof verification fails. - -#### Defined in - -[sdk/src/validator/index.ts:228](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/validator/index.ts#L228) - ---- - -### walletClientToSigner - -▸ **walletClientToSigner**(`walletClient`): `undefined` \| `Signer` & `TypedDataSigner` - -This function converts a `WalletClient` instance to an ethers.js `Signer` to faciliate compatibility between ethers and viem. - -It extracts the account, chain, and transport from the `WalletClient` and creates a network object. -If no chain is found in the `WalletClient`, it logs a warning and stops the signature request. -It then creates a `Web3Provider` with the transport and network, and gets a `Signer` from the provider using the account's address. - -Ref: https://viem.sh/docs/ethers-migration.html - -#### Parameters - -| Name | Type | Description | -| :--------------------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `walletClient` | `Object` | The `WalletClient` instance to convert. | -| `walletClient.account` | `undefined` \| `Account` | The Account of the Client. | -| `walletClient.addChain` | (`args`: `AddChainParameters`) => `Promise`<`void`\> | Adds an EVM chain to the wallet. - Docs: https://viem.sh/docs/actions/wallet/addChain - JSON-RPC Methods: [`eth_addEthereumChain`](https://eips.ethereum.org/EIPS/eip-3085) **`Example`** `ts import { createWalletClient, custom } from 'viem' import { optimism } from 'viem/chains' const client = createWalletClient({ transport: custom(window.ethereum), }) await client.addChain({ chain: optimism }) ` | -| `walletClient.batch?` | `Object` | Flags for batch settings. | -| `walletClient.batch.multicall?` | `boolean` \| \{ batchSize?: number \| undefined; wait?: number \| undefined; } | Toggle to enable `eth_call` multicall aggregation. | -| `walletClient.cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | -| `walletClient.ccipRead?` | `false` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | -| `walletClient.chain` | `undefined` \| `Chain` | Chain for the client. | -| `walletClient.deployContract` | (`args`: `DeployContractParameters`<`abi`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`\>) => `Promise`<\`0x$\{string}\`\> | Deploys a contract to the network, given bytecode and constructor arguments. - Docs: https://viem.sh/docs/contract/deployContract - Examples: https://stackblitz.com/github/wevm/viem/tree/main/examples/contracts/deploying-contracts **`Example`** `ts import { createWalletClient, http } from 'viem' import { privateKeyToAccount } from 'viem/accounts' import { mainnet } from 'viem/chains' const client = createWalletClient({ account: privateKeyToAccount('0x…'), chain: mainnet, transport: http(), }) const hash = await client.deployContract({ abi: [], account: '0x…, bytecode: '0x608060405260405161083e38038061083e833981016040819052610...', }) ` | -| `walletClient.extend` | (`fn`: (`client`: `Client`<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, `WalletActions`<`undefined` \| `Chain`, `undefined` \| `Account`\>\>) => `client`) => `Client`<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, \{ [K in keyof client]: client[K]; } & `WalletActions`<`undefined` \| `Chain`, `undefined` \| `Account`\>\> | - | -| `walletClient.getAddresses` | () => `Promise`<`GetAddressesReturnType`\> | Returns a list of account addresses owned by the wallet or client. - Docs: https://viem.sh/docs/actions/wallet/getAddresses - JSON-RPC Methods: [`eth_accounts`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_accounts) **`Example`** `ts import { createWalletClient, custom } from 'viem' import { mainnet } from 'viem/chains' const client = createWalletClient({ chain: mainnet, transport: custom(window.ethereum), }) const accounts = await client.getAddresses() ` | -| `walletClient.getChainId` | () => `Promise`<`number`\> | Returns the chain ID associated with the current network. - Docs: https://viem.sh/docs/actions/public/getChainId - JSON-RPC Methods: [`eth_chainId`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_chainid) **`Example`** `ts import { createWalletClient, http } from 'viem' import { mainnet } from 'viem/chains' const client = createWalletClient({ chain: mainnet, transport: custom(window.ethereum), }) const chainId = await client.getChainId() // 1 ` | -| `walletClient.getPermissions` | () => `Promise`<`GetPermissionsReturnType`\> | Gets the wallets current permissions. - Docs: https://viem.sh/docs/actions/wallet/getPermissions - JSON-RPC Methods: [`wallet_getPermissions`](https://eips.ethereum.org/EIPS/eip-2255) **`Example`** `ts import { createWalletClient, custom } from 'viem' import { mainnet } from 'viem/chains' const client = createWalletClient({ chain: mainnet, transport: custom(window.ethereum), }) const permissions = await client.getPermissions() ` | -| `walletClient.key` | `string` | A key for the client. | -| `walletClient.name` | `string` | A name for the client. | -| `walletClient.pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | -| `walletClient.prepareTransactionRequest` | (`args`: `PrepareTransactionRequestParameters`<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`<\{ [K in keyof (UnionRequiredBy, "transactionRequest", TransactionRequest\>, "from"\> & (DeriveChain<...\> extends Chain ? \{ ...; } : \{ ...; }) & (DeriveAccount<...\> extends Account ? \{ ...; } : \{ ...; }), IsNever<...\> extends true ? un...\> | Prepares a transaction request for signing. - Docs: https://viem.sh/docs/actions/wallet/prepareTransactionRequest **`Example`** `ts import { createWalletClient, custom } from 'viem' import { mainnet } from 'viem/chains' const client = createWalletClient({ chain: mainnet, transport: custom(window.ethereum), }) const request = await client.prepareTransactionRequest({ account: '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e', to: '0x0000000000000000000000000000000000000000', value: 1n, }) ` **`Example`** `ts // Account Hoisting import { createWalletClient, http } from 'viem' import { privateKeyToAccount } from 'viem/accounts' import { mainnet } from 'viem/chains' const client = createWalletClient({ account: privateKeyToAccount('0x…'), chain: mainnet, transport: custom(window.ethereum), }) const request = await client.prepareTransactionRequest({ to: '0x0000000000000000000000000000000000000000', value: 1n, }) ` | -| `walletClient.request` | `EIP1193RequestFn`<`WalletRpcSchema`\> | Request function wrapped with friendly error handling | -| `walletClient.requestAddresses` | () => `Promise`<`RequestAddressesReturnType`\> | Requests a list of accounts managed by a wallet. - Docs: https://viem.sh/docs/actions/wallet/requestAddresses - JSON-RPC Methods: [`eth_requestAccounts`](https://eips.ethereum.org/EIPS/eip-1102) Sends a request to the wallet, asking for permission to access the user's accounts. After the user accepts the request, it will return a list of accounts (addresses). This API can be useful for dapps that need to access the user's accounts in order to execute transactions or interact with smart contracts. **`Example`** `ts import { createWalletClient, custom } from 'viem' import { mainnet } from 'viem/chains' const client = createWalletClient({ chain: mainnet, transport: custom(window.ethereum), }) const accounts = await client.requestAddresses() ` | -| `walletClient.requestPermissions` | (`args`: \{ [x: string]: Record; eth_accounts: Record; }) => `Promise`<`RequestPermissionsReturnType`\> | Requests permissions for a wallet. - Docs: https://viem.sh/docs/actions/wallet/requestPermissions - JSON-RPC Methods: [`wallet_requestPermissions`](https://eips.ethereum.org/EIPS/eip-2255) **`Example`** `ts import { createWalletClient, custom } from 'viem' import { mainnet } from 'viem/chains' const client = createWalletClient({ chain: mainnet, transport: custom(window.ethereum), }) const permissions = await client.requestPermissions({ eth_accounts: {} }) ` | -| `walletClient.sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`<\`0x$\{string}\`\> | Sends a **signed** transaction to the network - Docs: https://viem.sh/docs/actions/wallet/sendRawTransaction - JSON-RPC Method: [`eth_sendRawTransaction`](https://ethereum.github.io/execution-apis/api-documentation/) **`Example`** `ts import { createWalletClient, custom } from 'viem' import { mainnet } from 'viem/chains' import { sendRawTransaction } from 'viem/wallet' const client = createWalletClient({ chain: mainnet, transport: custom(window.ethereum), }) const hash = await client.sendRawTransaction({ serializedTransaction: '0x02f850018203118080825208808080c080a04012522854168b27e5dc3d5839bab5e6b39e1a0ffd343901ce1622e3d64b48f1a04e00902ae0502c4728cbf12156290df99c3ed7de85b1dbfe20b5c36931733a33' }) ` | -| `walletClient.sendTransaction` | (`args`: `SendTransactionParameters`<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TRequest`\>) => `Promise`<\`0x$\{string}\`\> | Creates, signs, and sends a new transaction to the network. - Docs: https://viem.sh/docs/actions/wallet/sendTransaction - Examples: https://stackblitz.com/github/wevm/viem/tree/main/examples/transactions/sending-transactions - JSON-RPC Methods: - JSON-RPC Accounts: [`eth_sendTransaction`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_sendtransaction) - Local Accounts: [`eth_sendRawTransaction`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_sendrawtransaction) **`Example`** `ts import { createWalletClient, custom } from 'viem' import { mainnet } from 'viem/chains' const client = createWalletClient({ chain: mainnet, transport: custom(window.ethereum), }) const hash = await client.sendTransaction({ account: '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e', to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8', value: 1000000000000000000n, }) ` **`Example`** `ts // Account Hoisting import { createWalletClient, http } from 'viem' import { privateKeyToAccount } from 'viem/accounts' import { mainnet } from 'viem/chains' const client = createWalletClient({ account: privateKeyToAccount('0x…'), chain: mainnet, transport: http(), }) const hash = await client.sendTransaction({ to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8', value: 1000000000000000000n, }) ` | -| `walletClient.signMessage` | (`args`: `SignMessageParameters`<`undefined` \| `Account`\>) => `Promise`<\`0x$\{string}\`\> | Calculates an Ethereum-specific signature in [EIP-191 format](https://eips.ethereum.org/EIPS/eip-191): `keccak256("\x19Ethereum Signed Message:\n" + len(message) + message))`. - Docs: https://viem.sh/docs/actions/wallet/signMessage - JSON-RPC Methods: - JSON-RPC Accounts: [`personal_sign`](https://docs.metamask.io/guide/signing-data#personal-sign) - Local Accounts: Signs locally. No JSON-RPC request. With the calculated signature, you can: - use [`verifyMessage`](https://viem.sh/docs/utilities/verifyMessage) to verify the signature, - use [`recoverMessageAddress`](https://viem.sh/docs/utilities/recoverMessageAddress) to recover the signing address from a signature. **`Example`** `ts import { createWalletClient, custom } from 'viem' import { mainnet } from 'viem/chains' const client = createWalletClient({ chain: mainnet, transport: custom(window.ethereum), }) const signature = await client.signMessage({ account: '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e', message: 'hello world', }) ` **`Example`** `ts // Account Hoisting import { createWalletClient, http } from 'viem' import { privateKeyToAccount } from 'viem/accounts' import { mainnet } from 'viem/chains' const client = createWalletClient({ account: privateKeyToAccount('0x…'), chain: mainnet, transport: http(), }) const signature = await client.signMessage({ message: 'hello world', }) ` | -| `walletClient.signTransaction` | (`args`: `SignTransactionParameters`<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`<\`0x02$\{string}\` \| \`0x01$\{string}\` \| \`0x03$\{string}\` \| `TransactionSerializedLegacy`\> | Signs a transaction. - Docs: https://viem.sh/docs/actions/wallet/signTransaction - JSON-RPC Methods: - JSON-RPC Accounts: [`eth_signTransaction`](https://ethereum.github.io/execution-apis/api-documentation/) - Local Accounts: Signs locally. No JSON-RPC request. **`Example`** `ts import { createWalletClient, custom } from 'viem' import { mainnet } from 'viem/chains' const client = createWalletClient({ chain: mainnet, transport: custom(window.ethereum), }) const request = await client.prepareTransactionRequest({ account: '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e', to: '0x0000000000000000000000000000000000000000', value: 1n, }) const signature = await client.signTransaction(request) ` **`Example`** `ts // Account Hoisting import { createWalletClient, http } from 'viem' import { privateKeyToAccount } from 'viem/accounts' import { mainnet } from 'viem/chains' const client = createWalletClient({ account: privateKeyToAccount('0x…'), chain: mainnet, transport: custom(window.ethereum), }) const request = await client.prepareTransactionRequest({ to: '0x0000000000000000000000000000000000000000', value: 1n, }) const signature = await client.signTransaction(request) ` | -| `walletClient.signTypedData` | (`args`: `SignTypedDataParameters`<`TTypedData`, `TPrimaryType`, `undefined` \| `Account`\>) => `Promise`<\`0x$\{string}\`\> | Signs typed data and calculates an Ethereum-specific signature in [EIP-191 format](https://eips.ethereum.org/EIPS/eip-191): `keccak256("\x19Ethereum Signed Message:\n" + len(message) + message))`. - Docs: https://viem.sh/docs/actions/wallet/signTypedData - JSON-RPC Methods: - JSON-RPC Accounts: [`eth_signTypedData_v4`](https://docs.metamask.io/guide/signing-data#signtypeddata-v4) - Local Accounts: Signs locally. No JSON-RPC request. **`Example`** `ts import { createWalletClient, custom } from 'viem' import { mainnet } from 'viem/chains' const client = createWalletClient({ chain: mainnet, transport: custom(window.ethereum), }) const signature = await client.signTypedData({ account: '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e', domain: { name: 'Ether Mail', version: '1', chainId: 1, verifyingContract: '0xCcCCccccCCCCcCCCCCCcCcCccCcCCCcCcccccccC', }, types: { Person: [ { name: 'name', type: 'string' }, { name: 'wallet', type: 'address' }, ], Mail: [ { name: 'from', type: 'Person' }, { name: 'to', type: 'Person' }, { name: 'contents', type: 'string' }, ], }, primaryType: 'Mail', message: { from: { name: 'Cow', wallet: '0xCD2a3d9F938E13CD947Ec05AbC7FE734Df8DD826', }, to: { name: 'Bob', wallet: '0xbBbBBBBbbBBBbbbBbbBbbbbBBbBbbbbBbBbbBBbB', }, contents: 'Hello, Bob!', }, }) ` **`Example`** `ts // Account Hoisting import { createWalletClient, http } from 'viem' import { privateKeyToAccount } from 'viem/accounts' import { mainnet } from 'viem/chains' const client = createWalletClient({ account: privateKeyToAccount('0x…'), chain: mainnet, transport: http(), }) const signature = await client.signTypedData({ domain: { name: 'Ether Mail', version: '1', chainId: 1, verifyingContract: '0xCcCCccccCCCCcCCCCCCcCcCccCcCCCcCcccccccC', }, types: { Person: [ { name: 'name', type: 'string' }, { name: 'wallet', type: 'address' }, ], Mail: [ { name: 'from', type: 'Person' }, { name: 'to', type: 'Person' }, { name: 'contents', type: 'string' }, ], }, primaryType: 'Mail', message: { from: { name: 'Cow', wallet: '0xCD2a3d9F938E13CD947Ec05AbC7FE734Df8DD826', }, to: { name: 'Bob', wallet: '0xbBbBBBBbbBBBbbbBbbBbbbbBBbBbbbbBbBbbBBbB', }, contents: 'Hello, Bob!', }, }) ` | -| `walletClient.switchChain` | (`args`: `SwitchChainParameters`) => `Promise`<`void`\> | Switch the target chain in a wallet. - Docs: https://viem.sh/docs/actions/wallet/switchChain - JSON-RPC Methods: [`eth_switchEthereumChain`](https://eips.ethereum.org/EIPS/eip-3326) **`Example`** `ts import { createWalletClient, custom } from 'viem' import { mainnet, optimism } from 'viem/chains' const client = createWalletClient({ chain: mainnet, transport: custom(window.ethereum), }) await client.switchChain({ id: optimism.id }) ` | -| `walletClient.transport` | `TransportConfig`<`string`, `EIP1193RequestFn`\> & `Record`<`string`, `any`\> | The RPC transport | -| `walletClient.type` | `string` | The type of client. | -| `walletClient.uid` | `string` | A unique ID for the client. | -| `walletClient.watchAsset` | (`args`: `WatchAssetParams`) => `Promise`<`boolean`\> | Adds an EVM chain to the wallet. - Docs: https://viem.sh/docs/actions/wallet/watchAsset - JSON-RPC Methods: [`eth_switchEthereumChain`](https://eips.ethereum.org/EIPS/eip-747) **`Example`** `ts import { createWalletClient, custom } from 'viem' import { mainnet } from 'viem/chains' const client = createWalletClient({ chain: mainnet, transport: custom(window.ethereum), }) const success = await client.watchAsset({ type: 'ERC20', options: { address: '0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2', decimals: 18, symbol: 'WETH', }, }) ` | -| `walletClient.writeContract` | (`args`: `WriteContractParameters`<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`<\`0x$\{string}\`\> | Executes a write function on a contract. - Docs: https://viem.sh/docs/contract/writeContract - Examples: https://stackblitz.com/github/wevm/viem/tree/main/examples/contracts/writing-to-contracts A "write" function on a Solidity contract modifies the state of the blockchain. These types of functions require gas to be executed, and hence a [Transaction](https://viem.sh/docs/glossary/terms) is needed to be broadcast in order to change the state. Internally, uses a [Wallet Client](https://viem.sh/docs/clients/wallet) to call the [`sendTransaction` action](https://viem.sh/docs/actions/wallet/sendTransaction) with [ABI-encoded `data`](https://viem.sh/docs/contract/encodeFunctionData). **Warning: The `write` internally sends a transaction – it does not validate if the contract write will succeed (the contract may throw an error). It is highly recommended to [simulate the contract write with `contract.simulate`](https://viem.sh/docs/contract/writeContract#usage) before you execute it.** **`Example`** `ts import { createWalletClient, custom, parseAbi } from 'viem' import { mainnet } from 'viem/chains' const client = createWalletClient({ chain: mainnet, transport: custom(window.ethereum), }) const hash = await client.writeContract({ address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2', abi: parseAbi(['function mint(uint32 tokenId) nonpayable']), functionName: 'mint', args: [69420], }) ` **`Example`** `ts // With Validation import { createWalletClient, custom, parseAbi } from 'viem' import { mainnet } from 'viem/chains' const client = createWalletClient({ chain: mainnet, transport: custom(window.ethereum), }) const { request } = await client.simulateContract({ address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2', abi: parseAbi(['function mint(uint32 tokenId) nonpayable']), functionName: 'mint', args: [69420], } const hash = await client.writeContract(request) ` | - -#### Returns - -`undefined` \| `Signer` & `TypedDataSigner` - -An ethers.js `Signer` instance, or `undefined` if no chain is found in the `WalletClient`. - -#### Defined in - -[sdk/src/utils/adapters.ts:51](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/utils/adapters.ts#L51) diff --git a/docs/docs/developer/burning.md b/docs/docs/developer/burning.md deleted file mode 100644 index 331ebc52..00000000 --- a/docs/docs/developer/burning.md +++ /dev/null @@ -1,12 +0,0 @@ -# Burning - -> :construction: **NOTE**: This is a work-in-progress and may not be fully functioning yet. - -## Burning fraction tokens - -You can only burn fraction tokens that you own. Hypercert claims cannot be burned once minted. -You can get a list of all fraction tokens you own with [this query](./querying.md#claimtokensbyowner). - -```js -const txHash = await hypercerts.burnClaimFraction({ claimId }); -``` diff --git a/docs/docs/developer/config.md b/docs/docs/developer/config.md deleted file mode 100644 index 3689e557..00000000 --- a/docs/docs/developer/config.md +++ /dev/null @@ -1,96 +0,0 @@ -# Hypercert Client Configuration - -The client provides a high level interface that communicates with the Graph, IPFS and the evm. For easy setup we harmonised the configuration into a flow that allows for configuration with different levels of specificity. - -## Configuration - -### Setup - -The SDK allows for minimal configuration, explicit overrides and defining values in environment variables. We apply the following hierarchy: - -1. Overrides declared in `Partial` - -Based on the chainID we load the default config for the respected chain, if it's supported. - -We then process the rest of the overrides and possible environment variables to customise the default configuration. - -To get started quickly you can either: - -- initialize a new client by calling `new HypercertClient({chain: {id: 11155111})`. - -Using either of the options above will launch the client in `read only` mode using the defaults in [constants.ts](https://github.com/hypercerts-org/hypercerts/blob/main/sdk/src/constants.ts) - -### Read-only mode - -The SDK client will be in read-only mode if any of the following conditions are true: - -- The client was initialized without an operator. -- The client was initialized with an operator without signing abilities. -- The contract address is not set. - -If any of these conditions are true, the read-only property of the `HypercertClient` instance will be set to true, and a warning message will be logged indicating that the client is in read-only mode. - -### Defaults - -The [constants.ts](https://github.com/hypercerts-org/hypercerts/blob/main/sdk/src/constants.ts) file defines various defaults constants that are used throughout the Hypercert system. - -`DEPLOYMENTS`: This constant defines the deployments that are managed by the Hypercert system. Each Deployment object -contains information about a specific deployment, including the chain ID, chain name, contract address, and graph name. - -For example: - -```json -{ - "11155111": { - "addresses": { - "HypercertMinterUUPS": "0x1234567890abcdef1234567890abcdef12345678", - "TransferManager": "0x1234567890abcdef1234567890abcdef12345678", - "...": "...", - "StrategyHypercertFractionOffer": "0x1234567890abcdef1234567890abcdef12345678" - }, - "graphName": "hypercerts-sepola", - "graphUrl": "https://api.thegraph.com/subgraphs/name/hypercerts-admin/hypercerts-sepolia" - } -} -``` - -You can select which deployment to use by passing in a `chainId` configuration parameter. We also allow for `overrides` -when creating the SDK by passing configuration variables. - -### Client config properties - -HypercertClientConfig is a configuration object used when initializing a new instance of the HypercertClient. It allows -you to customize the client by setting your own providers or deployments. At it's simplest, you only need to provide -`chain.id` to initalize the client in `readonly` mode. - -| Field | Type | Description | -| --------------------------- | ------- | ---------------------------------------------------------------------------------------------- | -| `chain` | Object | Partial configuration for the blockchain network. | -| `contractAddress` | String | The address of the deployed contract. | -| `graphUrl` | String | The URL to the subgraph that indexes the contract events. Override for localized testing. | -| `graphName` | String | The name of the subgraph. | -| `easContractAddress` | String | The address of the EAS contract. | -| `publicClient` | Object | The PublicClient is inherently read-only and is used for reading data from the blockchain. | -| `walletClient` | Object | The WalletClient is used for signing and sending transactions. | -| `unsafeForceOverrideConfig` | Boolean | Boolean to force the use of overridden values. | -| `readOnly` | Boolean | Boolean to assert if the client is in read-only mode. | -| `readOnlyReason` | String | Reason for read-only mode. This is optional and can be used for logging or debugging purposes. | - -### Logging - -The logger for the SDK uses the log level based on the value of the LOG_LEVEL environment variable. The log level -determines which log messages are printed to the console. By default, the logger is configured to log messages with a -level of info or higher to the console. - -In your `.env` file: - -```bash -LOG_LEVEL="info" -``` - -The SDK logger supports four log levels: `error`, `warn`, `info`, and `debug`. - -- The `error` log level is used to log errors that occur in the SDK. -- The `warn` log level is used to log warnings that do not necessarily indicate an error, but may be important to investigate. -- The `info` log level is used to log general information about the SDK's state or behavior. -- The `debug` log level is used to log detailed information that is useful for debugging purposes. diff --git a/docs/docs/developer/errors.md b/docs/docs/developer/errors.md deleted file mode 100644 index 291bb9f0..00000000 --- a/docs/docs/developer/errors.md +++ /dev/null @@ -1,20 +0,0 @@ -# Errors in the SDK - -Generally, we follow the pattern of throwing on errors and letting those surface to the application. This allows for developers to handle any (un)expected errors in a manner they find suitable. - -### Handling Errors - -To support debugging we've implemented some custom errors. - -| Error | Description | Payload | -| ----------------------- | ---------------------------------------------------- | ---------------------------- | -| `ClientError` | An error that is caused by a problem with the client | `{ "key": "value" }` | -| `ContractError` | An error that is returned by the contract | \`{ "data": "BaseError | -| `FetchError` | Fails fetching a remote resource | `{ "key": "value" }` | -| `InvalidOrMissingError` | The provided value was undefined or empty | `{ "key": "value" }` | -| `MintingError` | Minting transaction failed | `{ "key": "value" }` | -| `StorageError` | Fails storing to a remote resource | `{ "key": "value" }` | -| `UnknownSchemaError` | Schema could not be loaded | `{ "schemaName": "string" }` | -| `MalformedDataError` | Data doesn't conform to expectations | `{ "key": "value" }` | -| `UnsupportedChainError` | This blockchain is not yet supported | \`{ "chainID": "string | -| `ConfigurationError` | The configuration was invalid | `{ "key": "value" }` | diff --git a/docs/docs/developer/index.md b/docs/docs/developer/index.md deleted file mode 100644 index 1baebcca..00000000 --- a/docs/docs/developer/index.md +++ /dev/null @@ -1,49 +0,0 @@ -# Developer Documentation for Hypercerts - -Welcome to the developer documentation for Hypercerts! This guide will provide you with all the information you need to get started with developing applications using Hypercerts. - -## API Documentation - -The API documentation section contains detailed information about the hypercerts SDK and contracts. You will find everything you need to integrate Hypercerts into your applications. - -## NPM packages - -We provide the following NPM packages for you to use in your applications: - -- [SDK](https://www.npmjs.com/package/@hypercerts-org/sdk) -- [Contracts](https://www.npmjs.com/package/@hypercerts-org/contracts) - -## Starter app - -The starter app repo contains a sample application that demonstrates how to use the Hypercerts SDK to create a simple web application based on Next.js, Chakra UI, and the Hypercerts SDK. - -[Starter app repository](https://github.com/hypercerts-org/hypercert-nextjs-chakra-starter) - ---- - -**NOTE** - -The starter app is a template to feel free to fork it and get started quickly. - ---- - -## Demo Apps - -In the demo apps repo, you will find a collection of sample applications that show the bare minimum to implement hypercerts. These apps serve as a starting point for your own development and can be used as a reference to understand how to implement the SDK. - -[Demo apps repository](https://github.com/hypercerts-org/demo-apps) - -## Issue Tracking - -If you encounter any issues or have questions while working with hypercerts, the issue tracking is the place to go. Here, you can find a list of known issues, report new issues, and participate in discussions with the hypercerts community. - -[Issues on GitHub](https://github.com/hypercerts-org/hypercerts/issues) - -## Quickstarts - -The quickstarts section provides step-by-step guides to help you quickly get up and running with Hypercerts. Whether you are a beginner or an experienced developer, these guides will walk you through the process of setting up your development environment and creating your first Hypercerts application. - -[Quickstart Javascript](./quickstart-javascript.md) -[Quickstart Solidity](./quickstart-solidity.md) - -We hope you find this developer documentation helpful in your journey with Hypercerts. Happy coding! diff --git a/docs/docs/developer/minting.md b/docs/docs/developer/minting.md deleted file mode 100644 index f826759b..00000000 --- a/docs/docs/developer/minting.md +++ /dev/null @@ -1,57 +0,0 @@ -# Minting - -## Token design - -Hypercerts are semi-fungible tokens. -Thus, each hypercert is represented on-chain by a group of fraction tokens, -each representing a fraction of ownership over the hypercert. -If you want to split your fraction token, or merge multiple tokens into one, -check out the section on [splitting and merging](./split-merge.md). - -## Minting your first hypercert - -To mint a hypercert you need to provide the `metadata`, total amount of `units` and the preferred `TransferRestrictions`. -The resulting hypercert will be wholly owned by the creator. - -```js -import { TransferRestrictions, formatHypercertData } from "@hypercerts-org/sdk" - -const { metadata } = formatHypercertData(...); -const totalUnits = 10000n; - -const txHash = await hypercerts.mintClaim({ - metadata, - totalUnits, - transferRestrictions: TransferRestrictions.FromCreatorOnly, -}); -``` - -> **Note** If you did not initialize your HypercertsClient with an `walletClient`, the client will run in [read-only mode](#read-only-mode) and this will fail. - -Let's see what happens under the hood: - -First, `mintClaim` checks that the client is not `read only` and that the operator is a `Signer`. If not, it throws an `InvalidOrMissingError`. - -Next, the function validates the provided metadata using the `validateMetaData` function. If the metadata is invalid, it throws a `MalformedDataError`. The function then stores the metadata on `IPFS` using the `storeMetadata` method and returns the `CID` for the metadata. - -Finally, we call the mintClaim function on the contract with the signer `address`, total `units`, `CID`, and `transfer restriction` as parameters. If `overrides` are provided, the function uses them to send the transaction. Otherwise, it sends the transaction without overrides. - -## Transfer restrictions - -When minting a Hypercert, you must pass in a `TransferRestriction` policy. For now there are only 3 implemented policies: - -```js -enum TransferRestrictions { - // Unrestricted - AllowAll, - // All transfers disabled after minting - DisallowAll, - // Only the original creator can transfer - FromCreatorOnly -} -``` - -## Reference - -See the [code](https://github.com/hypercerts-org/hypercerts/tree/main/sdk/src/client.ts) -for more details on how we implement minting. diff --git a/docs/docs/developer/querying.md b/docs/docs/developer/querying.md deleted file mode 100644 index 80439bfe..00000000 --- a/docs/docs/developer/querying.md +++ /dev/null @@ -1,273 +0,0 @@ -# Querying - -## Overview - -The `HypercertClient` provides a high-level interface for interacting with the Hypercert ecosystem. The HypercertClient -has three getter methods: `storage`, `indexer`, and `contract`. These methods return instances of the HypercertsStorage, -HypercertIndexer, and HypercertMinter classes, respectively. - -```js -const { - client: { storage }, -} = new HypercertClient({ chain: { id: 11155111 } }); -``` - -The `storage` is a utility class that provides methods for storing and retrieving Hypercert metadata off-chain on IPFS. It is used by the HypercertClient to store metadata when creating new Hypercerts. - -```js -const { - client: { indexer }, -} = new HypercertClient({ chain: { id: 11155111 } }); -``` - -The `indexer` is a utility class that provides methods for indexing and searching Hypercerts based on various criteria. -It is used by the HypercertClient to retrieve event-based data via the subgraph. - -```js -const { - client: { contract }, -} = new HypercertClient({ chain: { id: 11155111 } }); -``` - -Finally we have a `contract` that provides methods for interacting with the HypercertMinter smart contract. It is used -by the HypercertClient to create new Hypercerts and retrieve specific on-chain information. - -By providing instances of these classes through the `storage`, `indexer`, and `contract` getters, the HypercertClient allows developers to easily interact with the various components of the Hypercert system directly. -For example, a developer could use the storage instance to store metadata for a new Hypercert, the indexer instance to search for existing Hypercerts based on various criteria, and the contract instance to create new Hypercerts and retrieve existing Hypercerts from the contract. - -## Indexer - -For indexing purposes, we rely on the [Graph](https://thegraph.com/docs/en/) to index Hypercert events. To make the subgraph easily accessible with typed methods and object we provide a client that wraps [urql](https://formidable.com/open-source/urql/) into an opiniated set of queries. - -### Live graph playground - -To inspect the subgraph and explore queries, have a look at the Graph playground for Goerli testnet and Optimism mainnet: - -- [Goerli dashboard](https://thegraph.com/hosted-service/subgraph/hypercerts-admin/hypercerts-testnet) -- [Optimism dashboard](https://thegraph.com/hosted-service/subgraph/hypercerts-admin/hypercerts-optimism-mainnet) - -### Graph client - -Since the client is fully typed, it's easy to explore the functionalities using code completion in IDEs. - -Here's one example from our frontend where we let [react-query](https://www.npmjs.com/package/%2540tanstack/react-query) frequently update the call to the graph: - -```js -import { useHypercertClient } from "./hypercerts-client"; -import { useQuery } from "@tanstack/react-query"; - -export const useFractionsByOwner = (owner: `0x${string}`) => { - const { - client: { indexer }, - } = useHypercertClient(); - - return useQuery( - ["hypercerts", "fractions", "owner", owner], - () => indexer.fractionsByOwner(owner), - { enabled: !!owner, refetchInterval: 5000 }, - ); -}; -``` - -### Queries: Claims - -These tables show the input parameters and output fields for each of the GraphQL queries in [claims.graphql](https://github.com/hypercerts-org/hypercerts/blob/main/sdk/src/indexer/queries/claims.graphql). -A claim represents 1 Hypercert and all of the common data across all claim/fraction tokens. - -#### `ClaimsByOwner` - -The `ClaimsByOwner` query retrieves an array of claims that belong to a specific owner. - -##### Input - -The query takes the following input parameters: - -| Parameter | Type | Description | Default Value | -| ---------------- | ---------------- | -------------------------------------------------- | ------------- | -| `owner` | `Bytes` | The address of the owner whose claims to retrieve. | "" | -| `orderDirection` | `OrderDirection` | The direction to order the claims. | `asc` | -| `first` | `Int` | The number of claims to retrieve. | `100` | -| `skip` | `Int` | The number of claims to skip. | `0` | - -##### Output - -The query returns an array of claim objects that match the input parameters. Each claim object has the following fields: - -| Field | Type | Description | -| ------------ | -------- | ------------------------------ | -| `contract` | `Bytes` | The address of the contract. | -| `tokenID` | `String` | The token ID. | -| `creator` | `Bytes` | The address of the creator. | -| `id` | `ID` | The ID of the claim. | -| `owner` | `Bytes` | The address of the owner. | -| `totalUnits` | `BigInt` | The total number of units. | -| `uri` | `String` | The URI of the claim metadata. | - -#### `RecentClaims` - -The RecentClaims query retrieves an array of the most recent claims on the Hypercert platform. - -##### Input - -The query takes the following input parameters: - -| Parameter | Type | Description | Default Value | -| ---------------- | ---------------- | ---------------------------------- | ------------- | -| `orderDirection` | `OrderDirection` | The direction to order the claims. | `asc` | -| `first` | `Int` | The number of claims to retrieve. | `100` | -| `skip` | `Int` | The number of claims to skip. | `0` | - -##### Output - -The query returns an array of claim objects that match the input parameters. Each claim object has the following fields: - -| Field | Type | Description | -| ------------ | -------- | ------------------------------ | -| `contract` | `Bytes` | The address of the contract. | -| `tokenID` | `String` | The token ID. | -| `creator` | `Bytes` | The address of the creator. | -| `id` | `ID` | The ID of the claim. | -| `owner` | `Bytes` | The address of the owner. | -| `totalUnits` | `BigInt` | The total number of units. | -| `uri` | `String` | The URI of the claim metadata. | - -#### `ClaimByID` - -The ClaimById query retrieves a single claim by its ID on the Hypercert platform. - -##### Input - -The query takes the following input parameters: - -| Parameter | Type | Description | -| --------- | ----- | -------------------------------- | -| `id` | `ID!` | The ID of the claim to retrieve. | - -##### Output - -The query returns a claim object that matches the input parameter. The claim object has the following fields: - -| Field | Type | Description | -| ------------ | -------- | ------------------------------ | -| `contract` | `Bytes` | The address of the contract. | -| `tokenID` | `String` | The token ID. | -| `creator` | `Bytes` | The address of the creator. | -| `id` | `ID` | The ID of the claim. | -| `owner` | `Bytes` | The address of the owner. | -| `totalUnits` | `BigInt` | The total number of units. | -| `uri` | `String` | The URI of the claim metadata. | - -### Queries: Fractions - -These tables show the input parameters and output fields for each of the GraphQL queries in [fractions.graphql](https://github.com/hypercerts-org/hypercerts/blob/main/sdk/src/indexer/queries/fractions.graphql). -A claim token represents a fraction of ownership of a Hypercert. - -#### `ClaimTokensByOwner` - -The `ClaimTokensByOwner` query retrieves an array of claim tokens that belong to a specific owner on the Hypercert platform. - -##### Input - -The query takes the following input parameters: - -| Parameter | Type | Description | Default Value | -| ---------------- | ---------------- | -------------------------------------------------------------------- | ------------- | -| `owner` | `Bytes` | The address of the owner whose claim tokens to retrieve. | "" | -| `orderDirection` | `OrderDirection` | The direction to order the claim tokens. The default value is `asc`. | `asc` | -| `first` | `Int` | The number of claim tokens to retrieve. The default value is `100`. | `100` | -| `skip` | `Int` | The number of claim tokens to skip. The default value is `0`. | `0` | - -##### Output - -The query returns an array of claim token objects that match the input parameters. Each claim token object has the following fields: - -| Field | Type | Description | -| --------- | -------- | ------------------------------------------ | -| `id` | `ID` | The ID of the claim token. | -| `owner` | `Bytes` | The address of the owner. | -| `tokenID` | `String` | The token ID. | -| `units` | `BigInt` | The number of units. | -| `claim` | `Claim` | The claim associated with the claim token. | - -The Claim object has the following fields: - -| Field | Type | Description | -| ------------ | -------- | ------------------------------------ | -| `id` | `ID` | The ID of the claim. | -| `creation` | `Int` | The timestamp of the claim creation. | -| `uri` | `String` | The URI of the claim metadata. | -| `totalUnits` | `BigInt` | The total number of units. | - -#### `ClaimTokensByClaim` - -The `ClaimTokensByClaim` query retrieves an array of claim tokens that belong to a specific claim on the Hypercert platform. - -##### Input - -The query takes the following input parameters: - -| Parameter | Type | Description | Default Value | -| ---------------- | ---------------- | -------------------------------------------------------------------- | ------------- | -| `claimId` | `String!` | The ID of the claim whose claim tokens to retrieve. | None | -| `orderDirection` | `OrderDirection` | The direction to order the claim tokens. The default value is `asc`. | `asc` | -| `first` | `Int` | The number of claim tokens to retrieve. The default value is `100`. | `100` | -| `skip` | `Int` | The number of claim tokens to skip. The default value is `0`. | `0` | - -##### Output - -The query returns an array of claim token objects that match the input parameters. Each claim token object has the following fields: - -| Field | Type | Description | -| --------- | -------- | -------------------------- | -| `id` | `ID` | The ID of the claim token. | -| `owner` | `Bytes` | The address of the owner. | -| `tokenID` | `String` | The token ID. | -| `units` | `BigInt` | The number of units. | - -#### `ClaimTokenById` Query - -The `ClaimTokenById` query retrieves a single claim token by its ID on the Hypercert platform. - -##### Input - -The query takes the following input parameters: - -| Parameter | Type | Description | -| --------- | ----- | -------------------------------------- | -| `id` | `ID!` | The ID of the claim token to retrieve. | - -##### Output - -The query returns a claim token object that matches the input parameter. The claim token object has the following fields: - -| Field | Type | Description | -| --------- | -------- | ------------------------------------------ | -| `id` | `ID` | The ID of the claim token. | -| `owner` | `Bytes` | The address of the owner. | -| `tokenID` | `String` | The token ID. | -| `units` | `BigInt` | The number of units. | -| `claim` | `Claim` | The claim associated with the claim token. | - -The Claim object has the following fields: - -| Field | Type | Description | -| ------------ | -------- | ------------------------------------ | -| `id` | `ID` | The ID of the claim. | -| `creation` | `Int` | The timestamp of the claim creation. | -| `uri` | `String` | The URI of the claim metadata. | -| `totalUnits` | `BigInt` | The total number of units. | - -## Storage - -### Hypercert Metadata - -Currently, all metadata is stored off-chain in IPFS. Use the `storage` client to retrieve the metadata - -```js -const claimId = "0x822f17a9a5eecfd...85254363386255337"; -const { indexer, storage } = hypercertsClient; -// Get the on-chain claim -const claimById = await indexer.claimById(claimId); -// Get the off-chain metadata -const metadata = await storage.getMetadata(claimById.claim.uri); -``` diff --git a/docs/docs/developer/quickstart-javascript.md b/docs/docs/developer/quickstart-javascript.md deleted file mode 100644 index ba133de6..00000000 --- a/docs/docs/developer/quickstart-javascript.md +++ /dev/null @@ -1,93 +0,0 @@ -# Getting started with JavaScript - -The Hypercerts SDK makes it easy to integrate Hypercerts into your application or backend with JavaScript/TypeScript. - -## Installation - -Install the SDK using npm or yarn: - -```bash -npm install @hypercerts-org/sdk -# OR yarn add @hypercerts-org/sdk -``` - -## Initialize - -Import the SDK into your project and create a new instance of `HypercertClient` with your configuration options: - -```js -import { HypercertClient } from "@hypercerts-org/sdk"; -import { createWalletClient, custom } from "viem"; -import { mainnet } from "viem/chains"; - -const walletClient = createWalletClient({ - chain: mainnet, - transport: custom(window.ethereum), -}); - -// NOTE: you should replace this with your own JSON-RPC provider to the network -// This should have signing abilities and match the `chainId` passed into HypercertClient - -const client = new HypercertClient({ - chainId: 11155111, // Sepolia testnet - walletClient, -}); -``` - -Hypercerts is a multi-chain protocol. -See [here](./supported-networks.md) for a list of currently supported networks. - -> **Note** If there's no `walletClient` provided, the client will run in [read-only mode](#read-only-mode). - -## Make a Hypercert - -Use the client object to interact with the Hypercert network. For example, you can use the `client.mintClaim` method to create a new claim: - -```js -import { - formatHypercertData, - TransferRestrictions, -} from "@hypercerts-org/sdk"; - -// Validate and format your Hypercert metadata -const { data: metadata, valid, errors } = formatHypercertData({ - name, - ... -}) - -// Check on errors -if (!valid) { - return console.error(errors); -} - -// Set the total amount of units available -const totalUnits: bigint = 10000n - -// Define the transfer restriction -const transferRestrictions: TransferRestrictions = TransferRestrictions.FromCreatorOnly - -// Mint your Hypercert! -const tx = await client.mintClaim( - metadata, - totalUnits, - transferRestrictions, -); -``` - -For guidance on how to specify your metadata, see the [minting guide](../minting-guide/step-by-step.md). -This will validate the metadata, store claim metadata on IPFS, create a new hypercert on-chain, and return a transaction receipt. - -For more details, check out the [Minting Guide](./minting.md). - -## Query for Hypercerts - -You can also use the client to query the subgraph and retrieve which claims an address owns: - -```js -const claims = await client.indexer.fractionsByOwner(owner), -``` - -For more details, checkout the [Querying guide](./querying.md) -and our [Graph playground](https://thegraph.com/hosted-service/subgraph/hypercerts-admin/hypercerts-optimism-mainnet). - -That's it! With these simple steps, you can start using the Hypercert SDK in your own projects. diff --git a/docs/docs/developer/quickstart-solidity.md b/docs/docs/developer/quickstart-solidity.md deleted file mode 100644 index 409a1e9d..00000000 --- a/docs/docs/developer/quickstart-solidity.md +++ /dev/null @@ -1,41 +0,0 @@ -# Getting started with Solidity - -> :construction: **NOTE**: This is a work-in-progress and may not be fully functioning yet. - -If you need the Solidity contracts or interfaces exported from the SDK, -please reach out by [filing an issue](https://github.com/hypercerts-org/hypercerts/issues). - -## Hypercerts deployments - -Hypercerts is a multi-chain protocol and we want to support any network that wants to make positive impact. -We plan to support at most 1 canonical contract deployment per network. -For a complete list of deployments and their contract addresses, see [Supported Networks](./supported-networks.md). - -## Installing the Hypercert contracts - -```bash -npm install @hypercerts-org/contracts -# or yarn add @hypercerts-org/contracts -``` - -## Using the Solidity interface - -If you want to call the Hypercerts contract on your network directly from Solidity, -we export the interface/ABI for you to use from your contract. - -```js -import { IHypercertToken } from "@hypercerts-org/contracts/IHypercertMinter.sol"; - -contract MyContract { - IHypercertToken hypercerts; - - function initialize(address _addr) public virtual initializer { - hypercerts = IHypercertToken(_addr); - } - - function uri(uint256 tokenID) public view returns (string memory _uri) { - _uri = hypercerts.uri(tokenID); - } -} - -``` diff --git a/docs/docs/developer/split-merge.md b/docs/docs/developer/split-merge.md deleted file mode 100644 index 1335884f..00000000 --- a/docs/docs/developer/split-merge.md +++ /dev/null @@ -1,15 +0,0 @@ -# Split and Merge - -> :construction: **NOTE**: This is a work-in-progress and may not be fully functioning yet. - -## By Token Value - -### Split / merge token values - -```js -const { tokenIds } = await hypercerts.splitFractionUnits({ - fractionId, - units: [10n, 12n, 15n], -}); -const { tokenId } = await hypercerts.mergeFractionUnits({ fractionIds }); -``` diff --git a/docs/docs/developer/supported-networks.md b/docs/docs/developer/supported-networks.md deleted file mode 100644 index f12ece5f..00000000 --- a/docs/docs/developer/supported-networks.md +++ /dev/null @@ -1,14 +0,0 @@ -# Supported networks - -Hypercerts is developed in public and released under [dual MIT and Apache license](https://github.com/hypercerts-org/hypercerts/blob/main/LICENSE). The Hypercert Foundation currently rolled out on a select set of networks: `Sepolia` for testing, `Optimism` and `Celo` as the production deployment. - -We want to support every network that wants to support positive impact! -If you want to see Hypercerts deployed on another network, please reach out by [filing an issue](https://github.com/hypercerts-org/hypercerts/issues). - -## Overview - -| Network | HypercertMinter (UUPS Proxy) | Safe | -| -------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -| Sepolia | [0xa16DFb32Eb140a6f3F2AC68f41dAd8c7e83C4941](https://goerli.etherscan.io/address/0xa16DFb32Eb140a6f3F2AC68f41dAd8c7e83C4941) | TBD | -| Celo | [0x16bA53B74c234C870c61EFC04cD418B8f2865959](https://celoscan.io/address/0x16bA53B74c234C870c61EFC04cD418B8f2865959) | TBD | -| Optimism | [0x822F17A9A5EeCFd66dBAFf7946a8071C265D1d07](https://optimistic.etherscan.io/address/0x822F17A9A5EeCFd66dBAFf7946a8071C265D1d07) | [0x560adA72a80b4707e493cA8c3B7B7528930E7Be5](https://optimistic.etherscan.io/address/0x560adA72a80b4707e493cA8c3B7B7528930E7Be5) | diff --git a/docs/docs/devops/deploy-proxy.md b/docs/docs/devops/deploy-proxy.md deleted file mode 100644 index 4ed58fc0..00000000 --- a/docs/docs/devops/deploy-proxy.md +++ /dev/null @@ -1,138 +0,0 @@ -# Deploy a new proxy contract - -This should be done only on rare occasions. For example, when: - -- We want to deploy to a new network -- We have updated the contract in a way that is _NOT_ backwards-compatible. - - For most upgrades, please use UUPS [upgrades](./upgrade.md). - -## Smart Contracts - -### Setup the `contracts/` environment - -Navigate to `contracts/`. Configure your `.env` file by following the instructions in the -[README](https://github.com/hypercerts-org/hypercerts/tree/main/contracts#setup). - -### Build and deploy the smart contracts - ---- - -**NOTE** - -While we use foundry for developement and testing, we use hardhat for deployment. This is because hardhat is more flexible and allows us to easily integrate with OpenZeppelin tools for upgradeable contracts. - ---- - -If you are deploying on a new network, configure `contracts/hardhat.config.ts` to support the new network under the `networks` key. - -```javascript - "sepolia": getChainConfig("sepolia"), -``` - -Build the contracts and deploy. Specify the network to match the key used in `hardhat.config.ts`. - -```sh -# Run in contracts/ -yarn build:hardhat -yarn hardhat deploy --network NETWORK -``` - -This will output the new proxy address. Update the root `README.md` with this new address. - -Now transfer ownership over the proxy contract to the multisig: - -```sh -yarn hardhat transfer-owner --network NETWORK --proxy PROXY_CONTRACT_ADDRESS --owner MULTISIG_ADDRESS -``` - -## Subgraph - -### Setup the `graph/` environment - -Navigate to `graph/`. Follow the instructions in the -[README](https://github.com/hypercerts-org/hypercerts/tree/main/graph#setup) -to get set up. - -### Deploy the subgraph - -Update `graph/networks.json` with the new proxy address. To speed up indexing, you set the `startBlock` to the block containing the contract creation. We can add multiple networks that are monitored by the same subgraph. For more details, see the [Graph documentation](https://thegraph.com/docs/en/deploying/deploying-a-subgraph-to-hosted/#deploying-the-subgraph-to-multiple-ethereum-networks). - -To separate test from production, we use a different subgraph for each network. This means that we need to deploy a new subgraph for each network; but we group the deployments in the scripts. - -- Create a new deploy script for the network in the `package.json` of the `graph/` directory. For example, if you are deploying to the `sepolia` network, you would add the following script: - -````json - "deploy:sepolia": "graph deploy --node https://api.thegraph.com/deploy/ --network sepolia hypercerts-admin/hypercerts-sepolia" - ``` - -* Add the deploy script to `deploy:test` or `deploy:prod` depending on whether you are deploying to a test or production network. - -* Now deploy the subgraph - -```sh -# Run in graph/ -yarn build -yarn deploy:test -```` - -## OpenZeppelin Defender - -### Create a new Supabase table - -Log into the [Supabase dashboard](https://app.supabase.com/). -We store all data in a single project, but use different tables for each network. -The table name should be suffixed by the network (e.g. `allowlistCache-goerli`). -If you are deploying to a new network, create a new table. You can copy the table schema and RLS policy from another pre-existing table. - -If you are deploying a new proxy contract to a network for which you already have another deployment, you'll have to make a judgement call as to whether you can reuse the existing table, whether you need to clear the existing table, or create another table. - -Note: We want to merge all the tables in this [issue](https://github.com/hypercerts-org/hypercerts/issues/477). - -### Update the OpenZeppelin Defender scripts - -Modify the Defender scripts to support the new network in `defender/src/networks.ts`. - -If the ABI of the contract has changed, make sure you also update `defender/src/HypercertMinterABI.ts`. - -Note: The entry point for deployment is in `defender/src/setup.ts`. - -### Setup the `defender/` environment - -Navigate to `defender/`. Follow the instructions in the -[README](https://github.com/hypercerts-org/hypercerts/tree/main/defender#setup) -to get set up. - -### Deploy defender scripts - -Deploy to OpenZeppelin Defender via - -```sh -# Run in defender/ -yarn deploy -``` - -## Hypercerts SDK - -TODO: Flesh this out - -Run the build in `contracts/`. - -(Soon to be deprecated) Publish `contracts/` to npm - -Configure the SDK to support the new network via the graphclient. - -Publish SDK to npm - -## Deploy the Dapp frontend - -Each frontend build is configured to run on a different network (e.g. `https://testnet.hypercerts.org`). You can use any CDN to serve the site (e.g. Netlify, Vercel, GitHub Pages, Cloudflare Pages, Fleek, Firebase Hosting). - -1. Configure your build environment with the environment variables specified in `frontend/.env.local.example`. - -2. Configure your builds to the following settings: - -- Build command: `yarn build:site` -- Build output directory: `/build` -- Root directory: `/` - -3. Configure the domain that you want for your build. diff --git a/docs/docs/devops/errors.md b/docs/docs/devops/errors.md deleted file mode 100644 index 05dc5b0c..00000000 --- a/docs/docs/devops/errors.md +++ /dev/null @@ -1,45 +0,0 @@ -# Errors - -## Deploying - -### Artifact for contract "HypercertMinter" not found - -#### Error message - -`Error HH700: Artifact for contract "HypercertMinter" not found.` - -#### Cause - -Attempting to deploy a contract with `npx hardhat deploy` before the contract has been compiled by hardhat. Contracts compiled by forge are currently not visible to hardhat (this could be a configuration problem). - -### insufficient funds for intrinsic transaction cost - -#### Error message - -`Error: insufficient funds for intrinsic transaction cost` - -#### Cause - -The environment variable `MNEMONIC` is not configured correctly. - -Alternatively, the wallet may not have enough funds for the selected network - -Causing pause twice - -Error: cannot estimate gas; transaction may fail or may require manual gas limit - -reason: 'execution reverted: Pausable: paused', - -#### Etherscan API - -Note: It can take between 5-10 minutes before a newly created etherscan API key becomes valid for queries to goerli. - -When using an etherscan API key that was too recently created, hardhat tasks using etherscan to verify transactions will exit with an error message: - -`Etherscan returned with message: NOTOK, reason: Invalid API Key` - -Despite this error the transaction may have succeeded, the hardhat task just can't confirm it. - -It is unknown if this is a problem for queries to mainnet as well. - -Metamask makes it very difficult to have multiple wallets. diff --git a/docs/docs/devops/index.md b/docs/docs/devops/index.md deleted file mode 100644 index 9b208595..00000000 --- a/docs/docs/devops/index.md +++ /dev/null @@ -1,18 +0,0 @@ -# DevOps - -We use this playbook to encapsulate our practices and current setup. - -## Setup dev environment - -- [Setup guide](./setup.md) -- [Plasmic setup](./plasmic.md) - -## Tasks - -- [Deploy new proxy contract](./deploy-proxy.md) -- [Upgrade contract](./upgrade.md) -- [Pause contract](./pause.md) - -## FAQ - -- [Common errors](./errors.md) diff --git a/docs/docs/devops/pause.md b/docs/docs/devops/pause.md deleted file mode 100644 index 2668f51e..00000000 --- a/docs/docs/devops/pause.md +++ /dev/null @@ -1,29 +0,0 @@ -# Pause / Unpause - -## Pause - -### Contract owned by an address - -Make sure you have set up your wallets and config from the [setup guide](./setup.md). - -To pause the contract, run the following, where `CONTRACT_ADDRESS` is the proxy address of the HypercertMinter, and `NETWORK` is one of the networks from `hardhat.config.ts`: - -```sh -yarn hardhat pause --network NETWORK --address CONTRACT_ADDRESS -``` - -### Contract owned by a multi-sig - -If we transferred ownership to a multisig, we can use -[OpenZeppelin Defender Admin](https://defender.openzeppelin.com/#/admin) -to propose a pause to be approved by the multisig. - -## Unpause - -Make sure you have set up your wallets and config from the [setup guide](./setup.md). - -To pause the contract, run the following, where `CONTRACT_ADDRESS` is the proxy address of the HypercertMinter, and `NETWORK` is one of the networks from `hardhat.config.ts`: - -```sh -yarn hardhat unpause --network NETWORK --address CONTRACT_ADDRESS -``` diff --git a/docs/docs/devops/plasmic.md b/docs/docs/devops/plasmic.md deleted file mode 100644 index 10e52f5b..00000000 --- a/docs/docs/devops/plasmic.md +++ /dev/null @@ -1,76 +0,0 @@ -# Plasmic setup - -## HypercertImage - -### Props - -hideImpact - -``` -$ctx.currentForm.impactTimeEnd === "indefinite" && ($ctx.currentForm.impactScopes.length === 0 || ($ctx.currentForm.impactScopes.length === 1 && $ctx.currentForm.impactScopes[0] === "all")) -``` - -color - -``` -$ctx.currentForm.backgroundColor -``` - -vectorart - -``` -$ctx.currentForm.backgroundVectorArt -``` - -### Slots - -logoImage Image URL - -``` -$ctx.currentForm.logoUrl -``` - -title Content - -``` -$ctx.currentForm.name -``` - -workPeriod Content - -``` -`${$ctx.currentForm.workTimeStart.format ? $ctx.currentForm.workTimeStart.format("YYYY-MM-DD") : $ctx.currentForm.workTimeStart} → ${$ctx.currentForm.workTimeEnd.format ? $ctx.currentForm.workTimeEnd.format("YYYY-MM-DD") : $ctx.currentForm.workTimeEnd}` -``` - -bannerImage Image URL - -``` -$ctx.currentForm.bannerUrl -``` - -impactPeriod Content - -``` -`${$ctx.currentForm.workTimeStart.format ? $ctx.currentForm.workTimeStart.format("YYYY-MM-DD") : $ctx.currentForm.workTimeStart} → ${$ctx.currentForm.impactTimeEnd.format ? $ctx.currentForm.impactTimeEnd.format("YYYY-MM-DD") : $ctx.currentForm.impactTimeEnd}` -``` - -#### workScopes: repeated ScopeChip - -Collection - -``` -$ctx.currentForm.workScopes.split(/[,\n]/).map(i => i.trim()).filter(i => !!i) -``` - -Element name: `currentWorkScope` -Index name: `currentIndex` -Color variant: `$ctx.currentForm.backgroundColor` -Content: `currentWorkScope` - -#### impactScopes: repeated ScopeChip - -Collection: `$ctx.currentForm.impactScopes` -Element name: `currentImpactScope` -Index name: `currentIndex` -Color variant: `$ctx.currentForm.backgroundColor` -Content: `currentImpactScope` diff --git a/docs/docs/devops/setup.md b/docs/docs/devops/setup.md deleted file mode 100644 index afb95296..00000000 --- a/docs/docs/devops/setup.md +++ /dev/null @@ -1,41 +0,0 @@ -# Setup - -## Pre-requisites - -1. Install [NodeJS](https://nodejs.org/en/) and [git](https://git-scm.com/) -2. Install [yarn](https://classic.yarnpkg.com/) - -```sh -npm install --global yarn -``` - -3. Clone the repository: - -``` -git clone git@github.com:hypercerts-org/hypercerts.git -cd hypercerts -``` - -4. Install dependancies: - -To install dependencies across all projects in the monorepo workspace: - -```sh -yarn install -``` - -## Setup your wallets - -We need 2 wallets: a multi-sig for administering the contracts, and a hot wallet for setting everything up. - -1. We use a [Gnosis Safe](https://app.safe.global/) multisig for managing and administering the contracts. Set one up with your desired confirmation threshold (e.g. 2 of 3). This wallet will not require any balance. -2. Separately, set up a wallet that we'll use in our developer scripts. - -- If you don't have one, you can goto `contracts/` and run `yarn hardhat generate-address`. -- Make sure there is enough balance in this account to deploy the contract and transfer ownership to the multisig - - [Goerli Faucet](https://goerlifaucet.com/) - - [Optimism Bridge](https://app.optimism.io/bridge/deposit) - -## Next Steps - -Depending on what you want to do (e.g. in `./sdk/` or `./frontend/`), there will be further setup instructions in the respective `README.md` file. diff --git a/docs/docs/devops/upgrade.md b/docs/docs/devops/upgrade.md deleted file mode 100644 index 820255e7..00000000 --- a/docs/docs/devops/upgrade.md +++ /dev/null @@ -1,35 +0,0 @@ -# Upgrading the contract - -## Validate upgrade - -Validate contract upgradeability against deployment. - -For example, for the `goerli` deployment: - -```sh -yarn hardhat validate-upgrade --network goerli --proxy PROXY_CONTRACT_ADDRESS -``` - -## Propose Upgrade - -Propose an upgrade via OpenZeppelin Defender. For more information, see this -[guide](https://docs.openzeppelin.com/defender/guide-upgrades) - -For example, for the `goerli` deployment: - -```sh -yarn build:hardhat -yarn hardhat propose-upgrade --network goerli --proxy PROXY_CONTRACT_ADDRESS --multisig OWNER_MULTISIG_ADDRESS -``` - -This will output an OpenZeppelin URL that multi-sig members can use to approve/reject the upgrade. - -## Publish to npm - -After you update the contracts, deploy the `contracts/` package to npm. - -TODO - -Update the dependencies in `frontend/package.json` and `sdk/package.json`. - -If the ABI of the contract has changed, make sure you also update `defender/src/HypercertMinterABI.ts`. diff --git a/docs/docs/faq.md b/docs/docs/faq.md deleted file mode 100644 index b26970a2..00000000 --- a/docs/docs/faq.md +++ /dev/null @@ -1,138 +0,0 @@ ---- -title: Frequently Asked Questions -id: faq ---- - -# FAQs - -### How do I create a hypercert? - -We've created a step-by-step guide in the documents, which you can find [here](minting-guide/minting-guide-start). - -### Who gets to claim my hypercert? - -There are currently two types of users who are eligible to claim your hypercert. - -1. You as the creator of the hypercert are eligible to claim your hypercert. For projects with an allow list, you are eligible to claim 50% of the total tokens. For projects with no allow list, you will receive 100% of the tokens automatically and can do whatever you like with them. - -2. Anyone on the hypercert's allow list will be eligible to claim your hypercert. The allow list is stored and the time of minting and allocates fractions of the hypercert to specific wallet addresses. These wallet addresses are then allowed to claim these fractions through a separate contract interaction. Creators often use allow lists be used to allocate fractions to previous funders and contributors. - -### How do I claim a hypercert? Can I claim all of the ones I’m eligible for at once? - -After you connect your wallet, you will see a dashboard of hypercerts that you can claim. You can either claim them individually or in a batch transaction. Note that if you perform the batch transaction you will automatically claim _all_ hypercerts you are allow-listed for. (You still pay a gas fee for each claim, however.) If you don't want to claim _all_ at once, then you should claim them one-by-one. - -### What token standard do hypercerts utilize? - -The interface supports both ERC-1155s and 721s. Our current implementation makes use of [ERC-1155](https://eips.ethereum.org/EIPS/eip-1155) (a semi-fungible token). - -### What are the required fields to generate a hypercert? - -There are six required fields: - -1. Set of contributors: An ordered list of all contributors, who claim to do or have done the work described by this hypercert. -2. Scope of work: A conjunction of potentially-negated work scope tags, where an empty string means “all”. -3. Time of work: A date range, from the start to the end of the work being claimed by this hypercert. -4. Scope of impact: A conjunction of potentially-negated impact scope tags, where an empty string means “all”. -5. Time of impact: Date ranges from the start to the end of the impact. -6. Rights of the owners: An unordered list of usage rights tags, which define the rights of the owners of this hypercert over the work being claimed by this hypercert. - -Hypercerts also need a name and description. - -### What should I put for my hypercert's work scope? - -For most projects, it's probably best just to use a single tag that is a short form of your project's name. Given that your project may create numerous hypercerts over time, having a work scope that represents the name of your project will make your claims in the "impact hyperspace" more continuous. - -If you choose to use more than one tag, remember that tags are [logically conjunctive](https://en.wikipedia.org/wiki/Logical_conjunction), e.g. `Planting trees` ∧ `Germany` means that the hypercert includes the planting of trees only in Germany, but not planting trees anywhere else or any other work in Germany that wasn't planting trees. - -### Are hypercerts the same as impact evaluations? - -No. A hypercert is a claim over a discrete piece of work and the impact that may result from that work. It has no opinion about the legitimacy or quality of the claim. - -An impact evaluation is an opinionated assessment about the legitimacy or quality of a claim. - -For example, a hypercert might represent "Planting trees in the Amazon in 2022". An impact evaluation might point to that hypercert and assert the percent of trees that survived, the amount of CO2 removed by the trees, or the income change among people living around the project. - -Over time, the expectation is that hypercerts that attract multiple, high quality, credibly neutral impact evaluations will be more relevant than ones that do not. - -### What can I do with my hypercert? - -The `rights` dimension specific what an owner can do with their hypercert. Currently, the only `right` that owners have is "Public Display". Over time, we hope the protocol can support various `rights` including transfers, intellectual property, tax-deductibility, carbon offsets, ESG reporting, and more. - -### How is a hypercert different than a POAP or Impact NFT? - -Hypercerts have some things in common with certain POAPs or Impact NFTs, but also a number of crucial differences. - -First, all POAPs and most Impact NFTs are implemented as non-fungible tokens (ERC-721s). Hypercerts are currently being implemented as semi-fungible tokens (ERC-1155s), meaning it is possible to own more than one unit or fraction of a given hypercert. This makes it easy and intuitive to display the share of hypercerts that a given owner has. - -Second, hypercerts have specific metadata requirements and interpretation logic. These include a standard schema for how the six required hypercert dimensions are defined and captured (i.e., work scopes, impact scopes, timeframes, contributors, etc) as well as logic for how to interpret different inputs (e.g., how to include or exclude certain work scopes, create an indefinite time period, etc). POAPs have a completely different schema. Although there is no standard schema for Impact NFTs, an Impact NFT project could choose to adopt the hypercert standard and token interface and thereby achieve compatibility. - -Third, the hypercerts token interface is intended to support several functions that are not possible out of the box with other token standards, chiefly, atomic split and merge capabilities. We also expect other protocols to work with hypercerts for the purposes of prospective and retrospective funding, contributor verification, and impact evaluation. - -For certain use cases, POAPs may be better suited for projects as hypercerts are focused on the funding aspect of impactful work. - -### Where can I purchase a hypercert? - -Currently, it is only possible to purchase a hypercert from a creator or project. This can be facilitated directly by the project or via a third-party marketplace like OpenSea. Currently, hypercerts cannot be resold on secondary markets. - -### What chain(s) is hypercerts running on? - -The hypercerts smart contracts have been deployed on Optimism and Goerli Testnet. We plan to support various EVM chains in the near future. - -### How do I bridge to Optimism? - -There are various bridging services including the official [Optimism Bridge](https://app.optimism.io/bridge/deposit). Note that bridging assets from Ethereum to Optimism will incur a gas fee. - -### How much gas will it cost to create or claim a hypercert? - -In our simulations, the gas fee for minting a hypercert on Ethereum Mainnet ranged from 2,707,282 to 7,515,075 gwei (0.0027 to 0.0075 ETH). Minting costs are significantly cheaper on Optimism (i.e., below 0.0005 ETH or less than $1). Claiming a hypercert should be below 0.0001 ETH or less than $0.10 on Optimism. - -### How do I create a hypercert from a multisig? - -If you are creating a hypercert on Optimism, then you will need an Optimism-based multisig. (Unfortunately, Safe wallets created on Ethereum won't work on Optimism.) - -### Have the smart contracts been audited? - -Yes. The auditor's security report is available [here](https://github.com/pashov/audits/blob/master/solo/Hypercerts-security-review.md). - -### How is the allow list generated? - -For Gitcoin projects, an allow list is generated from a snapshot of all of the on-chain funding received by the project. - -The queries used to generate the allow lists can be viewed here: - -- ETH Infra: https://dune.com/queries/1934656 -- Climate: https://dune.com/queries/1934689 -- OSS: https://dune.com/queries/1934969 - -Once the snapshot is taken, the formula assigns one fraction (rounded down) for every $1 (using the exchange rate at the time of the transaction) that a donor contributed to the project. It also provides a small buffer (of 5%) so that a transaction worth $0.999 or $0.951 remains eligible for one fraction. - -For example: - -- $5.60 donated --> 5 fractions -- $5.20 donated --> 5 fractions -- $0.96 donated --> 1 fraction -- $0.52 donated --> 0 fractions - -### Why am I not on the allow list even though I contributed to the project? - -If you contributed less than $1 DAI to a project, then you will not be eligible to claim a hypercert fraction. - -### I supported a project. Why I don't I see the hypercert in my dashboard? - -In order to your hypercert to appear as "claimable", the project needs to mint the hypercert first. If the project has not minted its hypercert yet, then you will not be able to claim it. We suggest you check back in a few days to see if the project has created the hypercert and is now claimable. - -If the project has created its hypercert, then please try the following solutions: -1. Confirm the wallet address is correct (some users have multiple wallet addresses and forget which one they donated with) -2. Check that your wallet is included in the Dune Dashboards for each Gitcoin Round - -- ETH Infra: https://dune.com/queries/1934656 -- Climate: https://dune.com/queries/1934689 -- OSS: https://dune.com/queries/1934969 - -3. Confirm you donated more than $1 DAI to the project. - -If the project has created its hypercert, and you have confirmed items 1-3, then please send us a DM over Twitter or Telegram with your wallet address and we will get back to you promptly. - -### How do I retire a hypercert? - -We don't yet have a frontend for retiring hypercerts but you can do this by interacting directly with the smart contract on Etherscan. diff --git a/docs/docs/further-resources.md b/docs/docs/further-resources.md deleted file mode 100644 index e5ff8ab1..00000000 --- a/docs/docs/further-resources.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: Further Resources -id: further-resources ---- - -# Papers, Articles, Presentations - -## Writings - -* Feb 14, 2023, Whitepaper draft by [@hypercerts](http://twitter.com/hypercerts): [Hypercerts: A new primitive for impact funding systems (draft v0)](../static/pdf/hypercerts_whitepaper_v0.pdf) -* Aug 24, 2022, Blogpost by [@holkeb](https://twitter.com/holkeb): [Hypercerts: A new primitive for public goods funding](https://protocol.ai/blog/hypercert-new-primitive/) -* Jun 2022, Tech report (draft) by [@davidad](https://twitter.com/davidad): [Hypercerts; an Interoperable Datalayer for Impact-Funding Mechanisms](../static/pdf/hypercerts_Tech_Report_draft.pdf) - -## Talks - -#### Jun 24, 2022, Talk at [Funding the Commons](https://fundingthecommons.io/) by [@davidad](https://twitter.com/davidad): [Hypercerts: on-chain primitives for impact markets](https://youtu.be/2hOhOdCbBlU) - - - -#### Jun 23, 2022, Conversation between [@emiyazono](http://twitter.com/emiyazono) and [@owocki](http://twitter.com/owocki) at GreenPill Podcast: [Impact Certificates | Evan Miyazono, Head of Research at Protocol Labs | Green Pill #21](https://youtu.be/kyo5SxtSJ9U) - - - -#### Mar 4, 2022, Talk at [Funding the Commons](https://fundingthecommons.io/) by [@davidad](https://twitter.com/davidad): [Interoperable mechanisms for non-rival goods (Hypercerts)](https://youtu.be/acbBeGcevok) - - - - -## Other resources - -Overview of some previous writings on impact certificates, retrospective funding and impact markets: -* Christiano, Paul (2014) Certificates of impact, Rational Altruist, [https://rationalaltruist.com/2014/11/15/certificates-of-impact/](https://rationalaltruist.com/2014/11/15/certificates-of-impact/) -* Christiano, Paul & Katja Grace (2015) The Impact Purchase, [https://impactpurchase.org/why-certificates/](https://impactpurchase.org/why-certificates/) -* Optimism & Buterin, Vitalik (2021) Retroactive Public Goods Funding, [https://medium.com/ethereum-optimism/retroactive-public-goods-funding-33c9b7d00f0c](https://medium.com/ethereum-optimism/retroactive-public-goods-funding-33c9b7d00f0c) -* Cotton-Barratt, Owen (2021), Impact Certificates and Impact Markets, Funding the Commons November 2021, [https://youtu.be/ZiDV56o5M7Q](https://youtu.be/ZiDV56o5M7Q) -* Drescher, Denis (2022) Towards Impact Markets, [https://forum.effectivealtruism.org/posts/7kqL4G5badqjskYQs/toward-impact-markets-1](https://forum.effectivealtruism.org/posts/7kqL4G5badqjskYQs/toward-impact-markets-1) -* Ofer & Cotton-Barratt, Owen (2022) Impact markets may incentivize predictably net-negative projects, [https://forum.effectivealtruism.org/posts/74rz7b8fztCsKotL6](https://forum.effectivealtruism.org/posts/74rz7b8fztCsKotL6) diff --git a/docs/docs/implementation/glossary.md b/docs/docs/implementation/glossary.md deleted file mode 100644 index b35d4405..00000000 --- a/docs/docs/implementation/glossary.md +++ /dev/null @@ -1,139 +0,0 @@ ---- -title: Glossary -id: glossary -sidebar_position: 3 ---- - -# Glossary of Hypercerts Terms - -## Main Terms - -### Allowlist - -A list that determines how fractions of hypercerts will be allocated to new owners. The current implementation requires a project to specify an allowlist at the time of minting its hypercert. Based on allowlists, designated new owners are able to claim their fractions. - -### Claiming a fraction - -Transferring the ownership of a fraction of a hypercert to a (new) owner. Generally 'claiming' implies minting a new token that represents said fraction by the new owner. - -### Contributor - -An individual or organization that performs some or all of the work described in a hypercert. - -### Creating a hypercert - -Synonymous to minting a hypercert. - -### Fraction - -A token that represents a quantified proportion of a hypercert denominated in units. - -### Funder - -Individual, organization, or algorithm that funds work. There are generally two types: (1) **prospective** funders, who fund work _before_ it is done, and (2) **retrospective** funders, who fund work _after_ it is done. - -### Hypercert - -A token that (1) accounts for work by specified contributors that is supposed to be impactful, (2) represents the – potentially explicitly specified – impact of this work, and (3) assigns right over this work to its owners. If a hypercert is split into multiple fractions, the hypercert refers to the sum of all of its fractions. The term `hypercert` may also refer to an implementation of the hypercert interface and standard. - -### Hypercerts interface - -The hypercerts [contract interface](https://github.com/hypercerts-org/hypercerts/blob/main/contracts/src/protocol/interfaces/IHypercertToken.sol), which declares the required functionality for a hypercert token. The current interface includes functions for minting, burning, splitting, and merging of hypercert tokens. - -### Hypercerts implementation - -An implementation that builds on top of the hypercerts interface and conforms to the hypercerts standard. For instance, our initial implementation uses an [ERC-1155](https://eips.ethereum.org/EIPS/eip-1155) token. The first 128 bits of the 256-bit token ID identifies the hypercert, the latter 128 bits identifies the specific fraction. Other implementations are possible (e.g., based on ERC-721) as long as they also conform to the data standard and use the hypercerts interface to support capabilities like splitting and merging of values. - -### Hypercerts standard - -A data standard for hypercerts. It requires the following fields to be defined in the metadata of the token: (1) set of contributors, (2) scope of work, (3) time of work, (4) scope of impact, (5) time of impact, (6) rights. - -### Impact - -Value that is created or destroyed by work. It mostly refers to positive impact, i.e., value that is created. If work destroys value, it is referred to as negative impact. - -### Impact evaluation - -A claim that a specified impact has or will occur – potentially claiming which work was responsible for the impact. - -### Impact Funding System (IFS) - -A system of actors (contributors, evaluators, funders) that interact according to a set of rules (funding mechanisms, coordination mechanisms) to maximize the domain-specific impact. - -### Impact space - -A geometrical space representing all possible work with its associated impact and rights. The space is spanned by the six fields specified in the hypercerts data standard: (1) set of contributors, (2) scope of work, (3) time of work, (4) scope of impact, (5) time of impact, (6) rights. - -### Merging hypercerts - -An operation to combine two or more hypercerts, such that the resulting, merged hypercert covers the exact same region in the impact space that the individual hypercerts covered. - -### Minting a hypercert - -Creating a new record for a hypercert on a blockchain. The properties of the hypercert (e.g., its timeframe and scope of work) are retrievable via this record. - -### Project - -Work by one or more contributors to achieve a goal. A project does not always need to be represented by one hypercert; it can be represented by multiple hypercerts (e.g., one hypercert per phase or milestone of a project). A hypercert can also represent multiple projects or even parts of multiple projects. - -### Prospective funder - -Individual, organization, or algorithm that fund work before it is done. - -### Retrospective funder - -Individual, organization, or algorithm that fund work after it is done. - -### Rights - -An unordered list of usage rights tags, which define the rights of the owners of a hypercert over the work being claimed by a hypercert. One of the axis of the impact space and part of the required fields in the hypercerts data standard. - -### Set of contributors - -An ordered list of all contributors, who claim to do or have done the work described by a hypercert. One axis of the impact space and part of the required fields in the hypercerts data standard. - -### Scope of impact - -A conjunction of potentially-negated impact scope tags, where an empty string means “all”. One axis of the impact space and part of the required fields in the hypercerts data standard. - -### Scope of work - -A conjunction of potentially-negated work scope tags, where an empty string means “all”. One axis of the impact space and part of the required fields in the hypercerts data standard. - -### Splitting hypercerts - -An operation to split one hypercert into two or more separate hypercerts, such that the resulting, separated hypercerts cover the exact same region in the impact space that the previous hypercert covered. - -### Time of impact - -Date ranges from the start to the end of the impact being claimed by a hypercert. One axis of the impact space and part of the required fields in the hypercerts data standard. - -### Time of work - -A date range, from the start to the end of the work being claimed by a hypercert. One axis of the impact space and part of the required fields in the hypercerts data standard. - -### Unit - -The smallest possible fraction of a claim. Generally units are grouped in fractions. - -### Work - -Activities that produce impact. - -## Additional Impact Evaluation Terms - -### Auditor - -Individual, organization, or algorithm that evaluates the impact of work after it is done. - -### Beneficiaries - -People or objects that are impacted by work. - -### Evaluator - -Individual, organization, or algorithm that evaluates the impact of work. There are two types: Scouts evaluate the potential impact before it is done, auditors evaluate the impact after it is done. - -### Scout - -Individual, organization, or algorithm that evaluates the potential impact of work before it is done. diff --git a/docs/docs/implementation/metadata.md b/docs/docs/implementation/metadata.md deleted file mode 100644 index a2684229..00000000 --- a/docs/docs/implementation/metadata.md +++ /dev/null @@ -1,190 +0,0 @@ ---- -title: Metadata Standard -id: metadata -sidebar_position: 2 ---- - -# Hypercert Metadata Structure - -Hypercerts are represented as [ERC-1155](https://eips.ethereum.org/EIPS/eip-1155) tokens. All token instances of a hypercert must share the same ERC-1155 metadata. For sites like OpenSea to pull in off-chain metadata for ERC-1155 assets, your hypercert contract will need to return an IPFS URI that contains all necessary hypercert metadata. - -The hypercert metadata schema follows the [Enjin recommendation](https://github.com/ethereum/EIPs/blob/master/EIPS/eip-1155.md#erc-1155-metadata-uri-json-schema) for ERC-1155 metadata. It also includes **six required dimensions** that are necessary to clearly and unambiguously identify the hypercert's impact claim. - -The following are standard ERC-1155 metadata fields. - -## ERC-1155 fields - -| Property | Description | -| -------- | -------- | -| `name` | Name or title of the hypercert. Given that a project may create numerous hypercerts over time, consider giving the hypercert a name that represents a discrete phase or output.| -| `description` | A human readable description of the hypercert. Markdown is supported. Additional external URLs can be added.| -| `image` | A URI pointing to a resource with mime type image/* that represents the hypercert's artwork, i.e., `ipfs://`. We recommend images at a width between 320 and 1080 pixels and aspect ratio between 1.91:1 and 4:5 inclusive.| -| `external_url` | [optional] A URL that can be displayed next to the hypercert on webpages like OpenSea and links users to a page that has more information about the project or impact claim.| -| `properties` | [optional] Additional properties (aka attributes) that may be helpful for discovery and curation of hypercerts. Marketplaces like OpenSea will display these properties in the same way as they display rarity traits of NFTs. | - -In order to perform hypercert-specific operations, including split and merge functions, and for your hypercert to robustly claim a set of coordinates in the impact space, there are six additional dimensions that must be included in your metadata. - -## Required Hypercert dimensions - -| Property | Description | -| -------- | -------- | -| `work_scope` | An *ordered list* of work scope tags. Work scopes may also be excluded from the claim. The `¬` prefix will be displayed next to any work scope that is explicitly excluded from the claim. | -| `work_timeframe` | Date range from the start to the end of the work in the form of a [UTC timestamp](https://www.utctime.net/utc-timestamp). | -| `impact_scope` | An *ordered list* of impact scope tags. Impact scopes may also be excluded from the claim. The `¬` prefix will be displayed next to any impact scope that is explicitly excluded from the claim. The default claim is to "all" impact, giving the owner rights to claim all potential impact created by the work that is represented by the hypercert. | -| `impact_timeframe` | Date range from the start to the end of the impact in the form of a [UTC timestamp](https://www.utctime.net/utc-timestamp). The default claim is from the start date of work until `indefinite` (i.e., the impact may occur at any point in time in the future).| -| `contributors` | An *ordered list* of all contributors. Contributors should be itemized as wallet addresses or ENS names, but may be names / pseudonyms. The default claim is to the wallet address that created the hypercert contract. A multisig wallet can be used to represent a group of contributors. | -| `rights` | An *unordered list* of usage rights tags. The default claim is solely to "public display" of the hypercert, i.e., all other rights remain with the contributors. | - -## Examples - -### Example 1: hypercert with minimal bounds - -Here is an example of hypercert dimensions for work on IPFS with minimal bounds: - -``` -"hypercert": { - "work_scope": { - "name": "Work Scope", - "value": ["IPFS"], - "excludes": [], - "display_value": "IPFS" - }, - "impact_scope": { - "name": "Impact Scope", - "value": ["All"], - "excludes": [], - "display_value": "All" - }, - "work_timeframe": { - "name": "Work Timeframe", - "value": [1380585600, 1388534399], - "display_value": "2013-10-01 -> 2013-12-31" - }, - "impact_timeframe": { - "name": "Impact Timeframe", - "value": [1380585600, 0], - "display_value": "2013-10-01 -> Indefinite" - }, - "contributors": { - "name": "Contributors", - "value": ["Protocol Labs"], - "display_value": "Protocol Labs" - }, - "rights": { - "name": "Rights", - "value": ["Public Display"], - "display_value": "Public Display" - } -} -```` - -### Example 2: hypercert with bounded impact claims -This hypercert is for a carbon removal project that provides a bounded impact scope. - - -``` -"hypercert": { - "work_scope": { - "name": "Work Scope", - "value": ["Protecting Trees in Amazon"], - "excludes": [], - "display_value": "Protecting Trees in Amazon" - }, - "impact_scope": { - "name": "Impact Scope", - "value": ["CO2 in Atmosphere"], - "excludes": [], - "display_value": "CO2 in Atmosphere" - }, - "work_timeframe": { - "name": "Work Timeframe", - "value": [1356998400, 1388534399], - "display_value": "2013-01-01 -> 2013-12-31" - }, - "impact_timeframe": { - "name": "Impact Timeframe", - "value": [1356998400, 0], - "display_value": "2013-01-01 -> Indefinite" - }, - "contributors": { - "name": "Contributors", - "value": ["0xa1fa1fa000000000000000000000000000000000", "Project Forest Conservation"], - "display_value": "0xa1f...000, Project Forest Conservation" - }, - "rights": { - "name": "Rights", - "value": ["Public Display"], - "display_value": "Public Display" - } -} -``` - -### Example 3: hypercert with excluded impact claims -Here is an example that explicitly excludes an impact scope to generate a more fine-grained claim. - - -``` -"hypercert": { - "work_scope": { - "name": "Work Scope", - "value": ["Protecting Trees in Amazon"], - "excludes": [], - "display_value": "Protecting Trees in Amazon" - }, - "impact_scope": { - "name": "Impact Scope", - "value": ["All"], - "excludes": ["CO2 in Atmosphere"], - "display_value": "All ∧ ¬CO2 in Atmosphere" - }, - "work_timeframe": { - "name": "Work Timeframe", - "value": [1356998400, 1388534399], - "display_value": "2013-01-01 -> 2013-12-31" - }, - "impact_timeframe": { - "name": "Impact Timeframe", - "value": [1356998400, 0], - "display_value": "2013-01-01 -> Indefinite" - }, - "contributors": { - "name": "Contributors", - "value": ["0xa1fa1fa000000000000000000000000000000000", "Project Forest Conservation"], - "display_value": "0xa1f...000, Project Forest Conservation" - }, - "rights": { - "name": "Rights", - "value": ["Public Display"], - "display_value": "Public Display" - } -} -``` - - -### Additional guidelines - -Here are some additional guidelines for defining hypercert dimensions. - -- For most hypercerts, the `work_scope` is best represented as the name of the project or activity. Other information contained in the hypercert, namely, the `contributors` and the `work_timeframe` should provide sufficient context to disambiguate multiple claims from the same project. -- Similarly, for most hypercerts, the `impact_scope` will be most clearly represented as "all" (with an indefinite upper bound on the `impact_timeframe` dimensions). This gives the hypercert creator and its owners the flexibility to make claims about impact that may not have been observable or well-understood when the hypercert was created. - -- It is recommended to browse the `impact_scope` and `work_scope` tags that have already been created and are in use by your or other projects. (We are building a catalog to be available at [hypercerts.org](https://hypercerts.org).) Picking established tags can make it easier for users to discover, curate, and interact with your hypercert. In the long-run, we expect different ontologies to emerge in domains like climate solutions, open source software, etc, and picking more established tags will help prevent overlapping or duplicate claims. -- Tags for work scopes and impact scopes are [logically conjunctive](https://en.wikipedia.org/wiki/Logical_conjunction), e.g. `Planting trees` ∧ `Germany` means that the hypercert includes the planting of trees only in Germany, but not planting trees anywhere else or any other work in Germany that wasn't planting trees. -- Scopes that are explicitly excluded from the hypercert claim are enumerated separately and displayed with the `¬` prefix in the tag. Excluded scopes are not currently displayed on hypercert artwork. -- The order of tags matters only for display purposes. The hypercert artwork will only display a limited number of tags in the `impact_scope` and `work_scope` arrays due to image size and stylistic constraints. -- A `contributor` can be identified using any human-readable string. The base case is to set the `contributors` to the wallet address used to create the hypercert. A multisig wallet can be used to represent a group of contributors. - - -### Assigning `rights` - -In version 1.0 of the protocol, only one `rights` tag will be enabled: - -> **Public Display**: owners of the hypercert have the right to publicly display and receive social utility from their hypercert. - -This means that any other rights regarding the work described by the hypercert either remain with the original contributors or are governed by other agreements. - -Additional `rights` including the potential for certain types of transfers to be explicitly enabled will be released in subsequent versions. - -## Optional hidden properties - -Creators may wish to add other fields in their metadata that are not a part of the hypercert claim and are not for display on third-party marketplaces like OpenSea. These can be added by creating a `hidden_properties` field in the metadata. diff --git a/docs/docs/implementation/token-standard.md b/docs/docs/implementation/token-standard.md deleted file mode 100644 index a767c670..00000000 --- a/docs/docs/implementation/token-standard.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: Token Standard -id: token-standard -sidebar_position: 1 ---- - -### Hypercerts as a semi-fungible token - -In order to make the token identifiable, traceable, and transferable, hypercerts are represented as [ERC-1155 tokens](https://eips.ethereum.org/EIPS/eip-1155). The ERC-1155 standard enables a single deployed contract to store many hypercerts, facilitating simpler creation, transfers, as well as splitting and merging of hypercerts within a single namespace. As a semi-fungible token, each unique token represents a fraction of ownership of a hypercert. Hypercerts are then represented as a group of tokens, where the total ownership sums to 100%. In order to easily identify which hypercert a token belongs to, we utilize the upper 128 bits of a 256-bit token ID to identify the hypercert. All tokens within the same hypercert group should share the same [ERC-1155 Metadata](https://eips.ethereum.org/EIPS/eip-1155#metadata). - -![hypercert id](../../static/img/hypercert_id.png) - -For illustrative purposes, let us assume that token IDs are just 2 bytes long, where the first byte represents the hypercert ID and the last byte represents which fraction of ownership. Alice could create a new hypercert token 0x2301, representing 100% of hypercert 0x23. If Alice wanted to transfer 20% to Bob, Alice could perform a split operation by minting token 0x2302 and transferring 20% of value to it, such that tokens 0x2301 and 0x2302 represent 80% and 20% ownership respectively of hypercert 0x23. Then Alice transfers token 0x2302 to Bob. Similarly, they could merge these 2 tokens together, back to form a token that represented 100% ownership. In this case, the value of 0x2301 would be transferred to 0x2302, and then 0x2301 is subsequently burned. - -Alice can also choose to split or merge hypercerts along some dimension of the impact space. For example, Alice may split hypercert 0x23 into two new hypercerts — 0x24 representing work done before the year 2000, and 0x25 representing work done after 2000. The original hypercert 0x23 is burned and the two new hypercerts store a reference to the previous hypercert. When the history of splits and merges are indexed, we can easily trace through the provenance of any individual hypercert. - -### Claim Data - -Hypercert claim data, such as scope of work and the contributor list, is encoded in JSON format into the [ERC-1155 Metadata](https://eips.ethereum.org/EIPS/eip-1155#metadata). Claim data can be stored on-chain alongside the token, or in off-chain storage such as IPFS. For details on the JSON schema and how off-chain storage can be utilized, see the [hypercerts-sdk repository](https://github.com/hypercerts-org/hypercerts/tree/main/sdk). - -When considering whether to store hypercert metadata on-chain or off-chain, we can consider the different trade-offs to the user experience and cost, which may differ depending on which blockchain is being used. Storing data off-chain saves on costs, but could lead to on-chain claims without the metadata. Storing data on-chain adds additional security that the claims will not be forgotten but can lead to higher gas fees. - -Beyond the standard fields of hypercerts that locate the hypercert in the impact space, additional fields can be added. This allows for different templates in different impact areas, such as AI safety or biodiversity, as different additional information will be useful. Importantly, however, all hypercerts will be located in a single impact space – the additional fields do not change that. - -### Multi-chain support - -We expect hypercerts to exist in a multi-chain ecosystem, where the local deployment can be used to support the unique funding systems of that community. In order to visualize a single global impact space, we index the different contract deployments across chains and surface any potential hypercert claim conflicts. Because different blockchains support different subsets of programming languages, we do expect different implementations of the hypercert protocol to exist. However, they must adhere to the same hypercert data model to be indexed into the impact space. - -In order to decide which deployments to index into the hypercerts impact space, decentralized governance institutions will be used to govern the list of contract addresses used across all blockchains. diff --git a/docs/docs/intro.md b/docs/docs/intro.md deleted file mode 100644 index 0c4d7ca3..00000000 --- a/docs/docs/intro.md +++ /dev/null @@ -1,58 +0,0 @@ ---- -title: What Are Hypercerts? -id: intro ---- - -# What are hypercerts? - -### Hypercerts are a new token standard for tracking and rewarding positive impact. - -Each hypercert represents a unique impact claim capturing the following information: - -- a scope of work and its corresponding scope of impact -- a set of time frames for both the work and its impact -- a set of contributors – the organization or people behind the work -- a set of rights you get by owning a hypercert - -The hypercert itself is an ERC-1155 semi-fungible token with the information above stored as metadata on IPFS. Here’s an example. - -### Hypercert example - -#### Graphic representation - -![hypercert design example](../static/img/hypercert_example.png) - -#### Supplementary information (metadata) - -- **Title of hypercert:** Invention of the InterPlanetary Filesystem (IPFS) -- **Description:** The InterPlanetary File System (IPFS) is a set of composable, peer-to-peer protocols for addressing, routing, and transferring content-addressed data in a decentralized file system. -- **Link:** ipns://ipfs.tech/ - -#### Hypercert dimensions (metadata) - -- **Set of contributors:** 0xb794f5ea0ba39494ce839613fffba74279579268 _(example Ethereum address)_ -- **Scope of work:** IPFS ∧ ¬ go-ipfs -- **Time of work:** 2013-01-01 --> 2013-12-31 -- **Scope of impact:** All -- **Time of impact:** 2013-01-01 --> indefinite -- **Rights:** Public display - -### Why should you care? - -We spend trillions of dollars every year on public goods via governmental agencies, foundations, private donations and corporate spendings; however, we don’t effectively track this work – leaving us in the dark, hoping that it actually has the intended positive impact. - -We believe we can do better: - -- We should start by tracking this work consistently – this is what hypercerts are for. -- We should evaluate how impactful that work was – this is what the open evaluation system of hypercerts supports. -- We should reward the work that was exceptionally impactful – this is what the public display of hypercerts and retrospective funding is for. - -Doing this would unfold powerful incentives. Retrospective funding 1) provides incentives for creators to take on public goods projects with a potentially high, but uncertain, impact, 2) enables feedback loops to learn from successes and failures, and 3) attracts more talent to the public goods sector by improving performance-based compensation. - -While we are excited about the prospects of retrospective funding, hypercerts do not impose any specific funding mechanisms, but start with tracking the work that is supposed to be impactful. As a database for many funding mechanisms this facilitates experimentation and interoperability between funding mechanisms. - -### Next - -Curious and want to learn more? Head over to the [whitepaper](whitepaper/whitepaper-intro.md) to dive deeper into the world of hypercerts. - -Or do you want to get started right away? Head to the [minting guide](minting-guide/minting-guide-start.md). diff --git a/docs/docs/minting-guide/gitcoin-round.md b/docs/docs/minting-guide/gitcoin-round.md deleted file mode 100644 index 1ad2310a..00000000 --- a/docs/docs/minting-guide/gitcoin-round.md +++ /dev/null @@ -1,166 +0,0 @@ ---- -title: Gitcoin Alpha Round Instructions -id: gitcoin-round -sidebar_position: 3 ---- - -# Gitcoin Alpha Round Instructions - -## Overview - -- all projects in the Gitcoin Alpha Round are invited to mint a hypercert for their work -- anyone who gave over $1 to a project is automatically allowlisted for that project’s hypercert -- 50% of each hypercert is distributed to the funders, 50% is kept by the project and can be transferred later -- each project has a custom URL to make minting super easy (the link is sent directly to each project) -- everything runs on Optimism (users only need to pay L2 gas costs) - -:::info -If your project participated in the Gitcoin Alpha Round, but you didn't get a message with a custom URL, please reach out to team[at]hypercert.org. -::: - -## Hypercerts x Gitcoin Alpha Round - -Now that Gitcoin’s Alpha Round has officially closed and the funding distribution is finalized, we are inviting all eligible projects that participated to mint a hypercert for their past work and to allocate fractions of their hypercert to a list of supporters. - -We’ve created a dApp that pulls all of the data required to mint your hypercert directly from Gitcoin’s Grant Protocol. You can fine-tune the properties, tweak your artwork, and review the distribution mechanism. Once you’re ready, hit the create button and your hypercert will be released into the ethers! - -Once your hypercert has been minted, the people who supported your project with a contribution of at least $1 DAI on Gitcoin’s Alpha Round will be able to connect and claim their fractions. - -A few important notes about the Alpha Round: - -- The total units of a hypercert is based on the total donations; each funder get awarded units proportional to their donations. -- Transfers will be restricted to one transfer from the project to the supporters. -- There will be no additional rights awarded to the funders except the right to "public display" their support for the project. - -## Instructions - -The following guidance is only for projects that receive a custom URL that pre-populates the hypercerts form based on their Gitcoin Grants' data. - -It explains the default settings in the form and recommends fields that the creator may choose to update or edit. - -:::note -Gitcoin Grant hypercerts are for retrospective work, i.e., they are intended to capture work that happened between Gitcoin Grants Round 15 (September 2022) and the Alpha Round (January 2023). Therefore, the work time period is always set to past dates. (You might need to adjust the name and description to also refer to past work only.) We are focusing solely on retrospective hypercerts for this round as part of broader efforts to promote retrospective funding; you can read more about it [in the whitepaper](whitepaper/retrospective-funding.md). -::: - -### General Fields - -#### Name of Hypercert - -This field is set by default to the name of your project on Gitcoin Grants. You can edit this to be more specific. Given that your project may create numerous hypercerts over time, consider giving each hypercert a name that represents a more discrete phase or output. - -#### Logo - -This field is set to the icon artwork provided for your project on Gitcoin Grants. If there was an error accessing your icon, you will see a generic icon. - -You can update this by providing a new URL and the hypercert artwork should update automatically. - -Logo images look best with an aspect ratio of 1.0 (square-shaped). - -#### Background Banner Image - -This field is set to the banner artwork provided for your project on Gitcoin Grants. If there was an error accessing your banner, you will see a generic Gitcoin banner. - -You can update this by providing a new URL and the hypercert artwork should update automatically. - -Banner images look best with an aspect ratio of 1.5 (e.g., 600 x 400 pixels). The dimensions should be at least 320 pixels wide and 214 pixels high to avoid stretching. - -#### Project Description - -This field is set by default to the description of your project on Gitcoin Grants. Review closely -- a long project description in your Gitcoin Grant description will be truncated. - -You may edit this to provide more details about your work and to remove information that is targeted solely at Gitcoin Grants users. This is also a good place to provide other links, such as Github repos or social media accounts, where the general public can learn more about the work. Please aim for a project description that is less than 500 characters. - -:::note -The project description should refer to **past work**, not future work that you would like to do with additional funding. -::: - -#### Link - -This field is set to the first external URL provided for your project on Gitcoin Grants. You can update this. - -### Hypercert Fields - -#### Work Scope - -This field is set by default to a **shortened version** of the name of your project on Gitcoin Grants. You may edit or add additional work scope tags. - -For most projects, it's probably best just to use a single tag that is a short form of your project's name. Given that your project may create numerous hypercerts over time, having a work scope that represents the name of your project will make your claims in the "impact hyperspace" more continuous. - -If you choose to use more than one tag, remember that tags are [logically conjunctive](https://en.wikipedia.org/wiki/Logical_conjunction), e.g. `Planting trees` ∧ `Germany` means that the hypercert includes the planting of trees only in Germany, but not planting trees anywhere else or any other work in Germany that wasn't planting trees. - -#### Work Start/End Dates - -The start date has been set by default to the `2022-09-22` for all projects on Gitcoin Grants. This date coincides with the end of Gitcoin Grants Round 15. - -The end date references the last update to your grant page on Gitcoin Grants. - -You may edit or update these fields, however, the end date may not extend beyond `2023-01-31` (the close of the funding round) as all hypercerts will be retrospective in this round. - -#### Set of Contributors - -This field is set by default to the wallet address that is set as the recipient address for receiving Gitcoin Grants funding. - -:::note -You should review this field closely and – if applicable – provide the addresses of additional contributors. -::: - -### Advanced Fields - -#### Impact Scope - -This field is set by default to `all`. - -Updates are currently disabled on the frontend because funding decisions on Gitcoin Grants were not specific to an impact scope or impact time period. - -#### Impact Start/End Dates - -This field is set by default to the work start date of `2022-09-22` (see above) and a work end date of `indefinite`. Updates are currently disabled on the frontend. - -#### Rights - -This field is set by default to `Public Display`, i.e., the owners are allowed to publicly display the hypercert and show their support of the work. - -Updates are currently disabled on the frontend. - -### Distribution - -#### Allowlist - -This field is set by default to a custom allowlist generated for each project based on the funding it received on the Gitcoin Grants Alpha Round. You should not need to update this field. If there is a problem with your allowlist, please contact us. - -50% of the hypercert will be allocated according to this allowlist. The other 50% will be kept by the project, i.e. it is allocated to the address that mints the hypercert. You will be able to transfer or sell these fractions later as long as they are owned by the minter. This means that they can only be transferred or sold once. - -The formula assigns one fraction (rounded down) for every $1 (using the exchange rate at the time of the transaction) that a donor contributed to the project. It also provides a small buffer (of 5%) so that a transaction worth $0.999 or $0.951 remains eligible for one fraction. - -For example: - -- $5.60 donated --> 5 fractions -- $5.20 donated --> 5 fractions -- $0.96 donated --> 1 fraction -- $0.52 donated --> 0 fractions - -The queries used to generate the allowlists can be viewed here: - -- ETH Infra: https://dune.com/queries/1934656 -- Climate: https://dune.com/queries/1934689 -- OSS: https://dune.com/queries/1934969 - -Donors who contributed to the matching pool for each round are also eligible to claim hypercerts. - -:::note -You are free to edit your allowlist. You can do this by following the step-by-step instructions [here](minting-guide/step-by-step.md). Just remember that you will need to upload the new allowlist in a CSV format to a storage site like [web3.storage](https://web3.storage) and then update the link in the allowlist field. Contact team[at]hypercerts.org if you need help. -::: - -### Confirmations - -#### Contributors' permission - -Every contributor needs to agree to have their contribution be represented by a hypercert. This is why the person minting the hypercert has to confirm to have the permission of all listed contributors. - -#### Terms & Conditions - -The terms & Conditions can be found [here](https://hypercerts.org/terms). - -### Final step: Click "Create" - -Make sure your Optimism wallet or multi-sig is connected. Click on "create" and wait for your hypercert to be created. Congratulations! diff --git a/docs/docs/minting-guide/minting-guide-start.md b/docs/docs/minting-guide/minting-guide-start.md deleted file mode 100644 index 146f6142..00000000 --- a/docs/docs/minting-guide/minting-guide-start.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: Getting Started -id: minting-guide-start -sidebar_position: 1 ---- - -# Getting started - -### How to create a hypercert - -Creating a hypercert is similar to creating an NFT on sites like OpenSea or Zora. - -In this article, we’ll walk through the steps one by one and explain exactly what you need to do to create your first hypercert. - -There are typically two ways of creating a hypercert: -1. As a project affiliated with a specific funding network (e.g., Gitcoin Grants): In this case, you should receive a custom URL from the funding network that pre-populates most of your hypercert fields. You will still be able to change most of these, so you should review and adjust them as needed to better describe your hypercert. Guidance on how to do so (for Gitcoin Grants projects) is provided at the end of this doc. -2. As a project not affiliated with a specific funding network: In this case, you will be creating a hypercert from scratch and filling in each field on your own. Read on below. - -### Who can create a hypercert? - -Anyone doing work that is intended to have a positive impact can create a hypercert. Your hypercert can be as simple as "I did X on this date and want to claim all future impact from it". - -It can also represent something more, such as a phase in an ongoing team project, an invention or discovery, a research publication, or an important software release. - -Critically, if the work was done by more than one person, then each person should be listed as a contributor to the hypercert and approve the creation of the hypercert. - -*Note: In the future, the approval of each contributor will be verified on-chain.* - -### What do I need to create a hypercert? - -You will need to prepare all of the information required in the form builder (see **Step-by-step instructions for creating a hypercert** below). This includes important metadata, such as a description of the project and the dimensions of your impact claim, as well as a project artwork. You may also want to include an allowlist of wallets that are approved to claim one or more fractions of the hypercert. - -In addition to the information regarding the hypercert itself, you’ll need a crypto wallet to mint your hypercert. “Minting” a hypercert is the process of writing an impact claim to the blockchain. This establishes its immutable record of authenticity and ownership. - -Next, choose a blockchain on which to mint your hypercert. The hypercerts protocol is available on Ethereum, Goerli (testnet), and Optimism. Each of these blockchains has different gas fees associated with transactions on their networks. To reduce gas fees we recommend Optimism for most projects. - -Finally, go ahead and create your hypercert. - -### How much does it cost to create a hypercert? - -You will need enough Ethereum in your wallet to cover gas fees. In our simulations, the gas fee for minting a hypercert on Ethereum Mainnet ranged from 2,707,282 to 7,515,075 gwei (0.0027 to 0.0075 ETH). Minting costs are significantly cheaper on Optimism (i.e., below 0.0005 ETH or less than $1). - -The protocol currently does not offer gas-free or "lazy" minting. diff --git a/docs/docs/minting-guide/step-by-step.md b/docs/docs/minting-guide/step-by-step.md deleted file mode 100644 index 9f3b6303..00000000 --- a/docs/docs/minting-guide/step-by-step.md +++ /dev/null @@ -1,130 +0,0 @@ ---- -title: Step-by-step Instructions -id: step-by-step -sidebar_position: 2 ---- - -# Step-by-step instructions - -First, go to the [Create Hypercert](https://hypercerts.org/app/create) site with a wallet-enabled browser or follow the custom URL you received to access a prepopulated form. - -Although the site works on mobile, it is easier to use on desktop because the browser will display a dynamic preview of the hypercert while you fill out the Create form. - -Next, connect your wallet. You will be prompted to switch to the Ethereum or Optimism network. - -Once you've connected, you will see an empty form for creating a hypercert. - -### General fields - -#### Name of Hypercert - -Enter the name or title of the hypercert. This is the place to be verbose and specific about what the project is doing. You'll see on the preview when your title becomes too long. - -Given that a project may create numerous hypercerts over time, consider giving the hypercert a name that represents a discrete phase or output. - -Names are restricted to 100 characters but may include emojis (:smile:), accents (é), non-Latin scripts (表情), and other Unicode characters. - -#### Project Description - -Enter a human readable description of the hypercert. This is the place to share more details about the work and the team or individual behind the work. - -The description field supports [Markdown syntax](https://www.markdownguide.org/cheat-sheet/) and has a limit of 10,000 characters. - -In addition to the main link (see next field) you can add further links in the markdown to help others to understand the work of the project. - -#### Link - -A valid URL for the project, beginning with https:// - -This will be displayed next to the hypercert on webpages like OpenSea and should link users to a page that has more information about the project or impact claim. - -#### Logo - -An icon for the top left part of the card. This could be your project logo. It will be automatically masked to the shape of a circle. - -Logo images look best with an aspect ratio of 1.0 (square-shaped). - -The easiest way is to find an image you like in your web browser, right click "Copy Image Address", and paste it in the field. Images stored on IPFS should be referenced through a hosted URL service, e.g., `https://cloudflare-ipfs.com/ipfs/`. - -#### Background Banner Image - -A background image that will extend across the upper half of the artwork. This could be your project masthead or a unique piece of art. - -Banner images look best with an aspect ratio of 1.5 (e.g., 600 x 400 pixels). The dimensions should be at least 320 pixels wide and 214 pixels high to avoid stretching. - -Currently we don't support zoom / cropping, so you will need to test the look and feel on your own. - -The easiest way is to find an image you like in your web browser, right click "Copy Image Address", and paste it in the field. Images stored on IPFS should be referenced through a hosted URL service, e.g., `https://cloudflare-ipfs.com/ipfs/`. - -### Work Scope fields - -#### Work Scope - -One or multiple tags describe the work that the hypercert represents. This work scope will be used to identify the work that is included in the hypercerts and the work that is not included. - -Multiple tags are [logically conjunctive](https://en.wikipedia.org/wiki/Logical_conjunction), e.g. `Planting trees` ∧ `Germany` means that the hypercert includes the planting of trees only in Germany, but not planting trees anywhere else or any other work in Germany that wasn't planting trees. - -For most projects, it's probably best just to use a single tag that is a short form of your project's name. Given that your project may create numerous hypercerts over time, having a work scope that represents the name of your project will make your claims in the "impact hyperspace" more continuous. - -_Note: In the future, you will be able to specifically exclude work from the hypercert._ - -#### Start and End Date of Work - -The work time period defines when the work was done that the hypercert represents, i.e., only the work in this time period is included in the hypercert. - -The time period of work doesn't need to be the start and end date of a project, but it can be. One project can be split up into multiple hypercerts, e.g. all hypercerts can have the same `work scope`, but different time periods of work. Of course, the time periods are not allowed to overlap. - -### Impact scope fields - -#### Impact Scope - -The impact scope can be used to limit the impact that a hypercert represents, e.g. for the work scope `Planting trees` a hypercert can represent _only_ the impact on biodiversity by including the impact scope tag `Biodiversity`. This would exclude all other impacts, including the impact on CO2 in the atmosphere, which can be useful if that impact is already captured by a carbon credit. - -By default this is set to "`all`" and we strongly recommend keeping it that way. - -Just like the work scope, multiple impact scope tags are [logically conjunctive](https://en.wikipedia.org/wiki/Logical_conjunction). - -#### Start and End Date of Impact - -The impact time period is another way to limit the impact that a hypercert represents, e.g. inventing a new medical treatment has a positive impact over many years, but we might want to capture the positive impact separately for each year. - -By default the `impact start date` is the same as the `work start date` and the `impact end date` is "`indefinite`", i.e., the impact is not restricted time-wise. We strongly recommend keeping it that way. - -### Set of Contributors - -Provide a list of contributors, one per line, or comma-separated. - -The list should include _all_ contributors that performed the described work. - -Contributors are generally itemized as wallet addresses or ENS names, but can also be names / pseudonyms. Groups of contributors can be represented by a multisig or name of an organization. - -### Owners - -#### Allowlist - -The allowlist allocates fractions of the hypercert to specific wallet addresses. These wallet addresses are then allowed to claim these fractions afterwards. For example, it can be used to allocate fractions to previous funders and contributors. - -The allowlist is implemented as a CSV file specifying `index,address,price,fractions` headers. - -| index | address | price | fractions | -| ----- | ------------------------------------------ | ----- | --------- | -| 0 | 0x5dee7b340764c49a827c60d2b8729e49405fbefc | 0.0 | 100 | -| 1 | 0x1e2dbb9ca3f6d48e085384a821b7259abfdc7d65 | 0.0 | 50 | -| ... | ... | ... | ... | -| 999 | 0x436bad18642f45d3fa5fcaad0a2d81764a9cba85 | 0.0 | 1 | - -The `price` field is denominated in ETH. This should remain at 0.0 for all hypercerts, as primary sales are not currently supported through the app and the secondary sale/transfer of hypercerts is currently not allowed. - -You can store your allowlists on IPFS using [web3.storage](https://web3.storage/). - -:::note -If your allowlist is not properly formatted, you will be unable to mint your hypercert. If you do not include an allowlist, then the creator of the hypercert will receive 100% of the hypercert (set to a default of 10,000 units), which you can then sell or transfer to another wallet a maximum of one time. -::: - -#### Rights - -This field defines the rights that owners of the hypercert have over the work being claimed by this hypercert. - -By default this is set to `Public Display`, i.e., the owners are allowed to publicly display the hypercert and show their support of the work. - -_Note: In the future, additional rights can be included for different hypercerts._ diff --git a/docs/docs/whitepaper/evaluation.md b/docs/docs/whitepaper/evaluation.md deleted file mode 100644 index 0448c318..00000000 --- a/docs/docs/whitepaper/evaluation.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -title: Open Impact Evaluations -id: evaluation -sidebar_position: 5 ---- - -A key design element is that hypercerts themselves do not make a claim about the size of the impact, but only account for the work that is supposed to be impactful. The figure below shows this contrast in a simplified illustration of the example that we introduced above. The open evaluation system allows multiple evaluations to point at the same area of the impact space that a hypercert claims. The evaluations can include self-evaluation from the contributors themselves. Funders observe these and make their funding decisions based on this richer set of information. - -![hypercert evaluations](../../static/img/hypercert_evaluations.png) - -The open evaluation system is also used to provide additional information, e.g. an evaluator or the project itself provides information about the health of the trees. This information can then be used transparently by other evaluators to evaluate the impact on CO2 in the atmosphere. - -An important feature is that the evaluations do not directly point at a hypercert, but rather at an area in the impact space. In practice this area will mostly be the exact same area that a hypercert claims, such that it can be considered an evaluation of the hypercert, but it does not have to. This feature ensures that, if hypercerts are merged or split, previous evaluations will continue to be linked appropriately. - -The form of evaluations can be standardized to simplify handling and comparing multiple evaluations from multiple evaluators. The open evaluation system allows for templates to be created and used by any evaluators. Similar to the emerging ontologies, these are not enforced centrally, but should emerge as useful standards – potentially steered by decentralized governance institutions. - -Important characteristics of the open evaluation system are: -- Evaluators can submit multiple evaluations of the same area in the impact space as more information becomes available -- Evaluations can challenge other evaluations -- Evaluation methodologies can evolve over time - -These features allow the whole evaluation system to be dynamically improved by each actor. The relevant incentives for this improvement will stem from the funders who will value the signals from some evaluators more than others and evaluators are able to build up reputation. diff --git a/docs/docs/whitepaper/hypercerts-intro.md b/docs/docs/whitepaper/hypercerts-intro.md deleted file mode 100644 index b775a33f..00000000 --- a/docs/docs/whitepaper/hypercerts-intro.md +++ /dev/null @@ -1,91 +0,0 @@ ---- -title: 'Hypercerts: a New Primitive for Impact Funding Systems' -id: hypercerts-intro -sidebar_position: 3 ---- - -### Defining hypercerts -A hypercert is a semi-fungible token that accounts for work that is supposed to be impactful and represents all or parts of that impact. A hypercert has the following fields (one for each dimension): -1. **Set of contributors:** An ordered list of all contributors, who claim to do or have done the work described by this hypercert. -2. **Scope of work:** A conjunction of potentially-negated work scope tags, where an empty string means “all”: -``` - ::= AND | " " - ::= | NOT -``` -3. **Time of work:** A date range, from the start to the end of the work being claimed by this hypercert. -4. **Scope of impact:** A conjunction of potentially-negated impact scope tags, where an empty string means “all”: -``` - ::= AND | " " - ::= | NOT -``` -5. **Time of impact:** Date ranges from the start to the end of the impact. -6. **Rights of the owners:** An unordered list of usage rights tags, which define the rights of the owners of this hypercert over the work being claimed by this hypercert. - -Implementing hypercerts as a semi-fungible token allows multiple contributors and funders to own parts of hypercerts. For instance the original contributors can award 10% of a hypercert to a funder, while keeping 90%, which they can award to other funders later. This is why hypercerts are fractionalizable. - -### Examples -In the simplest cases of hypercerts, the scope of work and impact as well as the time of impact are not restricted and no rights are transferred to owners of the hypercerts, i.e. the hypercerts just define the who (set of contributors) and when (time of work) of the claimed work. Scope of work and impact would be set to all, time of impact to “indefinite” and the rights to only “public display of support”. The latter is always included as the hypercert is a public record, such that owners will always automatically display their support of the work. - -Take for example hypercert 1 below: It represents all work that contributor 1 has performed in 2013 with all the impact that the work had from the beginning of the work; the hypercert doesn’t give any additional rights to the owners of the hypercert. - -The other fields – except the rights field – can be used to limit the work or impact that is represented by the hypercert. Hypercert 2 limits this to the work on IPFS in 2013, i.e. any other work besides IPFS that contributor 1 performed is not included. Hypercert 3 limits it even further as it excludes a specific aspect of IPFS, the go-ipfs implementation. - -| | **Hypercert 1** | **Hypercert 2** | **Hypercert 3** | -|-------------------------|---------------------------|---------------------------|---------------------------| -| **Set of contributors** | Contributor 1 | Contributor 1 | Contributor 1 | -| **Scope of work** | all | IPFS | IPFS ∧ ¬ go-ipfs | -| **Time of work** | 2013-01-01 to 2013-12-31 | 2013-01-01 to 2013-12-31 | 2013-01-01 to 2013-12-31 | -| **Scope of impact** | all | all | all | -| **Time of impact** | 2013-01-01 → indefinite | 2013-01-01 → indefinite | 2013-01-01 → 2013-12-31 | -| **Rights** | Public display of support | Public display of support | Public display of support | - -In the table below we illustrate a use case for limiting the scope of impact. Suppose contributor 1 protects trees in a certain area. This work has positive effects on the CO2 in the atmosphere and could turn into carbon credits; however, the trees have additional positive impacts, such as protecting biodiversity. Instead of including all positive impacts in one hypercert (hypercert 4), the impact can be split between the impact on CO2 in the atmosphere (hypercert 5) and all other positive impacts (hypercert 6). If funders are willing to pay for biodiversity, this would be a new income opportunity. And it would account for the additional positive impact that other methods of reducing CO2 might not have, like industrial carbon capture. Importantly, negative impacts can not be excluded from a hypercert. - -| | **Hypercert 4** | **Hypercert 5** | **Hypercert 6** | -|-------------------------|----------------------------|----------------------------|----------------------------| -| **Set of contributors** | Contributor 1 | Contributor 1 | Contributor 1 | -| **Scope of work** | Protecting trees in area X | Protecting trees in area X | Protecting trees in area X | -| **Time of work** | 2013-01-01 to 2013-12-31 | 2013-01-01 to 2013-12-31 | 2013-01-01 to 2013-12-31 | -| **Scope of impact** | all | CO2 in atmosphere | all ∧ ¬ CO2 in atmosphere | -| **Time of impact** | 2013-01-01 → indefinite | 2013-01-01 → indefinite | 2013-01-01 → indefinite | -| **Rights** | Public display of support | Public display of support | Public display of support | - -Importantly a hypercert does not specify the “size” of the impact, e.g. a hypercert does not state “5 tons of CO2 removed from the atmosphere.” Instead the hypercert only defines the work, e.g. “200 trees protected” (scope of work) in 2022 (time of work). The size of the impact is then left to the evaluations of the “CO2 in the atmosphere” (scope of impact) in 2022 (time of impact) that point towards the covered region of the hypercert. For instance: This allows a self evaluation to claim that 5 tons of CO2 were removed in a given year as well as one or multiple evaluations from independent auditors to confirm or challenge how much CO2 has been removed. An evaluator could detect that some of the trees were not healthy and hence only 4 tons of CO2 were removed. Allowing for multiple evaluation is a defining characteristic of the open evaluation system. - -### Functions of hypercerts - -#### 1. Identifiability -Hypercerts clearly define the work that is supposed to be impactful by creating a record of who (set of contributors) claims to do or have done what (scope of work) in what time period (time of work). They also allow the creation of multiple records of the same work to identify separate impacts that this work had or will have (scope of impact) over specified time periods (time of impact). - -#### 2. Traceability -As these records are public and logically monotonic (immutable, except to split or merge hypercerts), records are durable and permanent. - -#### 3. Transferability -The records are a digital object that can be owned and ownership can be transferred (under specific conditions). As hypercerts can be created as fractionalizable, it is also possible to transfer only a specified fraction of the hypercert. Each hypercert defines the rights over the defined work that owners have, such as rights to retrospective rewards, rights to public display of the support (“bragging rights”) or rights to passive income from intellectual property. - -:::note Transferability restrictions - -Hypercerts are generally transferable. However, there are use cases, in which minters of hypercerts want to restrict how their hypercerts can be transferred. The protocol allows the minter to restrict who can transfer the hypercert and/or to whom the hypercert can be transferred. For instance, by specifying that only the original owner can transfer the hypercert, any future owner is prohibited from selling it, i.e. a secondary market would not exist for this hypercert. - -::: - -### Merging hypercerts -Besides the fungible dimension, hypercerts can be merged and split on any of the six dimensions as shown in box 1. Let us take the hypercert 1 from the section "Hypercerts definition" and focus only on two of the dimensions, scope of work and time of work. These two dimensions create a simplified impact space. The figure below shows how work on IPFS (InterPlanetary File System) could have been minted over time in separate hypercerts, one for each quarter of work. - -![minting hypercerts example](../../static/img/creating.png) - -We created five hypercerts, one for each quarter of work. As the resulting work of all of these together is IPFS 0.1, the merged hypercert in total is more meaningful and more valuable than just the five individual hypercerts. In this case the proverb is true, the whole is greater than the sum of its parts. Hence, we want to merge them as shown in the next figure. - -![merging hypercerts example](../../static/img/merging.png) - -### Splitting hypercerts -Conversely, splitting can increase the meaningfulness and value of hypercerts as well. We can split the work on IPFS 0.1 into the conceptual work “invention of IPFS” and the implementation via “go-ipfs 0.1” as shown in the next figure. - -![splitting hypercerts examples](../../static/img/splitting.png) - -Other use cases are where multiple contributors want to combine their work on the same scope of work (merging) or disentangle their work (splitting). Ultimately, splitting and merging allows users to repackage the digital representation of their work and impact. - -Importantly, splitting and merging are the only operations that are permitted to change hypercerts. Once an area in the impact space is claimed, it can not be unclaimed. This ensures that claims are never forgotten. - -### Retiring hypercerts -While a claim in the impact space can not be unclaimed, it can be retired. Retiring a hypercert means that owners can not transfer and sell it anymore. This way owners prove that they are the final buyers of the impact. Technically retiring hypercerts means that they are sent to a specific null address, which ensures that the retired hypercerts are recorded and traceable. diff --git a/docs/docs/whitepaper/ifs.md b/docs/docs/whitepaper/ifs.md deleted file mode 100644 index e996b393..00000000 --- a/docs/docs/whitepaper/ifs.md +++ /dev/null @@ -1,98 +0,0 @@ ---- -title: The Need for Interoperable Impact Funding Systems (IFSs) -id: ifs ---- - -# The Need for Interoperable Impact Funding Systems (IFSs) - -### An IFS consists of -- **Actors:** Contributors, funders, evaluators, and beneficiaries -- **Funding mechanisms:** Grants, bounties, retrospective funding, etc. -- **Coordination mechanisms:** Roadmapping, communication forums, etc. -- **A goal:** Maximize the domain-specific positive value created (impact) - -The goal will be specific to the impact area, e.g. prevent existential risks from artificial intelligence (AI) would be the goal for the impact area “AI safety.” To achieve these goals, skilled contributors must work with high effort on promising projects. Additionally, for those projects that create impact continuously, sufficient income streams are necessary to cover both their ongoing operating expenses and contributors’ upside incentives. - -#### Actors in IFSs - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeSubtypeDescription
ContributorsPeople or organizations who do the work
FundersProspective fundersPeople or organizations who fund work before it is done
Retrospective fundersPeople or organizations who fund work after it is done
EvaluatorsScoutsPeople or organizations who evaluate the potential impact of work before it is done
AuditorsPeople or organizations who evaluate the impact of work after it is done
BeneficiariesPeople or objects that are impacted by the work
- -### Guiding questions for designing IFSs -1. **Projects:** How can we improve the chances that the most promising projects are worked on? -2. **Talent & resources:** How can we attract top talent to contribute to the most promising projects and provide them with the necessary resources? -3. **Effort:** How can we reward contributors for their impact on outcomes? -4. **Sustainable income:** How can we create recurring income streams and financial sustainability for impactful projects? - -Markets have been proven very powerful in answering these questions if they are directed towards maximizing profits. As we are directing systems towards maximizing impact, these answers become more challenging. In particular, in an IFS we are facing coordination and incentive problems in funding impact, such as the free-rider problem. - -### Example dynamics between actors in an IFS -In order for impact funding systems to be most effective, they should be interoperable regarding (1) funding mechanisms, (2) funding sources and (3) evaluations. In the diagram below you see a potential dynamic between the actors of an IFS. In that scenario hypercerts can account for the prospective funding (steps 2-3) as well as for the retrospective funding (steps 8-9) from different funders. Evaluations are made public and can be discovered through the hypercerts for all funders (steps 5-7). Retrospective funders can reward not only the contributors but also the prospective funders (steps 10-11). - -```mermaid -sequenceDiagram - autonumber - participant Beneficiaries - participant Contributors - participant Prospective funders - participant Retrospective funders - participant Evaluators - Contributors ->> Contributors: Mint hypercerts - Prospective funders ->> Contributors: Award funding - Contributors ->> Prospective funders: Award fractions of
the hypercert - Contributors ->> Beneficiaries: Create impact - Retrospective funders ->> Evaluators: Fund evaluation - Evaluators ->> Beneficiaries: Evaluate impact on beneficiaries - Evaluators ->> Retrospective funders: Make evaluations public,
esp. for retrospective
funders - Retrospective funders ->> Contributors: Award funding - Contributors ->> Retrospective funders: Award fractions of hypercerts - opt - Retrospective funders ->> Prospective funders: Award funding - Prospective funders ->> Retrospective funders: Transfer fractions
of hypercert - end -``` - -### Hypercerts as a data layer for IFSs -By serving as a single, open, shared, decentralized database hypercerts lower the transaction costs to coordinate and fund impactful work together. This is important because the optimal funding decisions of a single funder depends on the funding decision of all other funders. For instance, some work is only impactful if a minimum funding is provided: The impact is non-linear in the funding amount, e.g. half a bridge is not half as impactful as a full bridge. Other work might be over-funded, i.e. the impact of an additional dollar is basically zero. Ultimately, funders want to find the highest impact for each additional dollar spend (cf. S-process as in Critch, 2021). Today multi-funder coordination on impact funding is prohibitively expensive, leading to suboptimal efficiency in impact capital allocation. Through hypercerts the funding becomes more transparent and the credits for funding impactful work can be easily shared. Coordinating funding becomes easier. - -Hypercerts don’t solve this coordination problem by themselves, but build the basis for different decision and funding mechanisms as shown below. Quadratic voting, bargaining solutions, DAO-style votes, milestone bounties, and simple unconditional grants all have their strengths, among others. Hypercerts do not lock in any particular decision-making scheme for funders. - -![Hypercerts as a data layer for an IFS](../../static/img/hypercert_data_layer.png) - -Looking farther into the future: If a large majority of funding across an entire IFS ends up flowing through hypercerts, funders have created the transparency that enables each of them to make the best decisions given the funding decision of everyone else. diff --git a/docs/docs/whitepaper/impact-space.md b/docs/docs/whitepaper/impact-space.md deleted file mode 100644 index a48ed942..00000000 --- a/docs/docs/whitepaper/impact-space.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: A Consistent Impact Space -id: impact-space -sidebar_position: 4 ---- - -Every hypercert represents a claim in the impact space, which itself represents all possible claims. Above we illustrated the impact space with two dimensions, scope and time of work. The complete impact space is spanned by the six dimensions introduced in the definition of hypercerts. - -### Consistency of the impact space - -Every point in the impact space should either be claimed or not be claimed. No point must be claimed twice, or equivalently: -- If the impact of some work is represented in one hypercert, it must not be part of any other hypercert. -- Hypercerts must not overlap with each other. - -The table below shows two hypercerts that were illustrated in the section on "Hypercerts operations", but now with all six fields. The two hypercerts can represent the exact same work by the same contributor, but they do not overlap because of the difference in the time of work. - -| | **Hypercert 7** | **Hypercert 8** | -|-------------------------|--------------------------|--------------------------| -| **Set of contributors** | Contributor 1 | Contributor 1 | -| **Scope of work** | IPFS | IPFS | -| **Time of work** | 2013-10-01 to 2013-12-31 | 2014-01-01 to 2014-03-31 | -| **Scope of impact** | all | all | -| **Time of impact** | 2013-10-01 → indefinite | 2014-01-01 → indefinite | -| **Rights** | None | None | - -The consistency of the impact space is crucial as it ensures that no rights to an impact claim are sold twice. If for example someone owns the right to retrospective rewards for the impact of some work, the owners must be identifiable unambiguously. - -Because users can create hypercerts with arbitrary data on any chain, on which a hypercert contract is deployed, we provide ways to help users detect collisions in the impact space. For example, if one hypercert on Ethereum points to the work on “IPFS”, and another hypercert on Filecoin points to the work on “https://github.com/ipfs/go-ipfs” both with the same contributor and time of work, which of these overlapping hypercerts is the correct one to support? To surface such overlapping hypercerts, the hypercerts protocol and SDK will support mechanisms to index, search, and visualize neighbors in the impact space. With these tools evaluators can quickly detect potential conflicts and submit the results as evaluations to help disambiguate proper credit and attribution. - -### Emerging ontologies -Common ontologies for the scope of work and scope of impact are useful to create transparency and improve discoverability. Such ontologies need to be created from the practices and should be adapted over time. They are like emerging norms, instead of fixed rules. However, some larger players or a group of smaller players could enforce certain ontologies, e.g. if multiple funders agree that they only fund projects that follow a specified ontology. - -As some ontologies might be more useful than others, we would ideally see a consensus emerge between participants and experts in each impact area. Decentralized governance institutions can help facilitate this; however, further details on the design are out of the scope of this paper and are left for future work. diff --git a/docs/docs/whitepaper/retrospective-funding.md b/docs/docs/whitepaper/retrospective-funding.md deleted file mode 100644 index 84e4ecf0..00000000 --- a/docs/docs/whitepaper/retrospective-funding.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: Retrospective Impact Funding -id: retrospective-funding -sidebar_position: 6 ---- - -### Introducing retrospective funding - -While hypercerts do not impose any specific funding mechanisms, they are especially useful for retrospective funding. The core idea, from the perspective of contributors building impactful goods, is this: if you can reasonably expect to get funded retrospectively for your work once you produce a positive impact, then you can work now, in expectation of a probabilistic future cash flow. In another conception, you are effectively “borrowing” money from this anticipated future cash flow to fund the work in the first place; the expectation of future funding “retro-causes” the impactful work. Retrospective funding may be able to 1) provide incentives for contributors to take on impactful goods projects with a potentially high, but uncertain, impact and 2) create a more efficient IFS by back-propagating signals on what outcomes were impactful post-hoc. - -In addition, contributors are able to receive fair compensation by providing outsized impact that will be highly valued. It incentivizes you to create a positive impact, beyond your intrinsic motivation. This does not mean that the most successful contributors to impactful goods automatically have potential upside comparable to some for-profit startup founders (or that they should), just that their potential upside does depend on how much funders later value their past work. This will attract more talent to the impact sector by improving performance-based compensation. - -The crucial aspect for this to work: funders need to retrospectively fund impact, and send credible signals that they will do so in the future. Based on these signals contributors form expectations about future retrospective rewards and can start working today to receive them in the future. - -Hypercerts facilitate retrospective funding as the impact claims are identifiable, traceable and transferable. Contributors can sell parts of their hypercerts to prospective funders to receive the necessary funding for their project (“activity” in the figure below). The project delivers impact to a larger group (“beneficiaries”), which retrospectively buys the hypercerts from the prospective funder, and from the contributors if they retained some fraction of their hypercerts (the latter is not represented in the figure). - -![Retrospective funding with hypercerts](../../static/img/retrospective_funding.png) - -### Increasing rewards - -Retrospective funding allows us to increase rewards as more impact is created because impact is easier to observe, measure and prove retrospectively. Increasing rewards – as shown in the next figure – incentivizes contributors to put in their highest effort to produce impact and enables contributors to be rewarded for their talent. Moreover, prospective funders are incentivized to select, fund and support the projects with the highest expected impact, if they also receive retrospective rewards. - -![Increasing rewards](../../static/img/increasing_rewards.png) - -Note that retrospective funding should not be used in cases where a significant negative impact is possible since a nongovernmental, permissionless framework can not impose retrospective penalties for negative externalities. See Ofer & Cotton-Barratt (2022) for a discussion of this limitation of retrospective funding. - -In some cases we do not expect the retrospective evaluation to be any different than the prospective evaluation, i.e. there is no uncertainty resolved over time as the impact of an activity is already “known” prospectively. In these cases retrospective funding would only complicate the funding mechanism and funding via grants or milestone bounties would be preferable. Retrospective funding is preferable only if uncertainty is resolved over time. - -### Impact evaluations - -The relevance of impact evaluations will depend on how much their signals influence the funding decisions of retrospective funders (see the potential dynamics in the section on "IFSs"). This is a critical difference to many impact reports today: If a project was funded by a grant, the funders as well as the project want to receive a positive evaluation. If, however, the funding decisions of the retrospective funders are outstanding, they are interested in truthful signals about the impact. Hence, funders value improvements in evaluation methodologies and can fund independent evaluators. Evaluators in turn would build up a reputation for their evaluation methodologies and improve the strength of their signals to retrospective funders. - -Impact evaluators can take on a range of forms ranging forms, such as -- Voting by relevant communities or beneficiaries -- Expert panels -- Professional evaluators similar to financial rating agencies -- Automatic monitoring and data collection by sensors and oracles - -The most useful form or combinations thereof will depend on the specific requirements of the impact area. For a generalized framework on impact evaluators see Protocol Labs (2023). - -While retrospective funding makes impact evaluations financially relevant for funders and contributors, hypercerts enable to pre-commit funding for those evaluations: As impact claims are never forgotten, any actor can at any time commit funding to a future evaluation of these claims. diff --git a/docs/docs/whitepaper/whitepaper-intro.md b/docs/docs/whitepaper/whitepaper-intro.md deleted file mode 100644 index 4d4648ba..00000000 --- a/docs/docs/whitepaper/whitepaper-intro.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: Introduction -id: whitepaper-intro ---- - -# Vision & Whitepaper - -:::note - -If you prefer to read the draft whitepaper (v0) as a pdf, you can find it [here](../../static/pdf/hypercerts_whitepaper_v0.pdf). The content is mostly identical to the following pages. - -::: - -#### The world faces unprecedented challenges, from climate change to safe artificial intelligence, that require billions to trillions of dollars of public goods funding. - -High-upside/high-uncertainty endeavors are often overlooked due to the absence of strong incentives to pursue them in the dominant public goods funding framework of at-cost grants or even a milestone-bounty framework (which directly exposes small contributors to aversive risk levels). Yet these should be pursued when the expected positive value is very high, as it often is. New impact funding mechanisms can address this. One such mechanism is retrospective funding, which rewards projects based on the impact they create after the impact is observable. If projects can reasonably expect such retrospective rewards, they are incentivized to maximize their impact and – together with prospective funders – take risky bets when the expected positive value is high. - -#### In order for Impact Funding Systems (IFSs) to be most effective, they should be interoperable regarding (1) funding mechanisms, (2) funding sources, and (3) evaluations. - -Quadratic voting, bargaining solutions, DAO-style votes, milestone bounties, and simple unconditional grants all have their strengths, among others. We do not wish to lock in any particular decision-making scheme for funders. Without mechanisms like these, multi-funder coordination on impact funding is prohibitively expensive, leading to suboptimal efficiency in impact capital allocation. Funders should be able to easily collaborate with other funders or to intentionally fund different projects to diversify the funded approaches. Evaluators should be able to evaluate the same impact with different methodologies – potentially with conflicting results, to foster rigor and progress of evaluation methodologies. - -#### Hypercerts create this interoperability by serving as a single, open, shared, decentralized database for impact funding mechanisms. - -A single hypercert is a semi-fungible token that accounts for work that is supposed to be impactful and whose ownership is fractionizable and transferable (under specific conditions). Hypercerts do not impose any specific funding mechanisms but provide baseline invariant guarantees such that claims will not be forgotten as different mechanisms come into and out of fashion. This is also why hypercerts are especially useful for any retrospective funding mechanisms – funding can be applied to claims of the past. diff --git a/docs/docusaurus.config.js b/docs/docusaurus.config.js deleted file mode 100644 index 810246db..00000000 --- a/docs/docusaurus.config.js +++ /dev/null @@ -1,148 +0,0 @@ -import { themes } from "prism-react-renderer"; - -export default async function createConfigAsync() { - // Use a dynamic import instead of require('esm-lib') - const mdx_mermaid = await import("mdx-mermaid"); - - return { - title: "Hypercerts", - tagline: "Accounting and rewarding impact with hypercerts", - url: "https://hypercerts-org.github.io/", - baseUrl: "/docs/", - onBrokenLinks: "log", - onBrokenMarkdownLinks: "warn", - favicon: "img/favicon.ico", - trailingSlash: false, - - // GitHub pages deployment config. - // If you aren't using GitHub pages, you don't need these. - organizationName: "Hypercerts Foundation", // Usually your GitHub org/user name. - projectName: "hypercerts", // Usually your repo name. - - // Even if you don't use internalization, you can use this field to set useful - // metadata like html lang. For example, if your site is Chinese, you may want - // to replace "en" with "zh-Hans". - i18n: { - defaultLocale: "en", - locales: ["en"], - }, - - plugins: [ - [ - "docusaurus-plugin-typedoc", - { - // TypeDoc options - entryPoints: ["../sdk/src/index.ts"], - tsconfig: "../sdk/tsconfig.json", - - // Plugin options - out: "developer/api/sdk", - sidebar: { - categoryLabel: "API SDK", - collapsed: false, - position: 0, - fullNames: true, - }, - }, - ], - ], - - presets: [ - [ - "classic", - /** @type {import('@docusaurus/preset-classic').Options} */ - { - blog: false, // Optional: disable the blog plugin - docs: { - routeBasePath: "/", // Serve the docs at the site's root - sidebarPath: "./sidebars.js", - // Please change this to your repo. - // Remove this to remove the "edit this page" links. - remarkPlugins: [mdx_mermaid], - editUrl: "https://github.com/hypercerts-org/hypercerts", - }, - theme: { - customCss: "./src/css/custom.css", - }, - }, - ], - ], - - markdown: { - mermaid: true, - format: "detect", - }, - themes: ["@docusaurus/theme-mermaid"], - themeConfig: { - algolia: { - // The application ID provided by Algolia - appId: "KEI1L137BU", - - // Public API key: it is safe to commit it - apiKey: "3c28007b9532f79a8f326cc2a07f1721", - - indexName: "hypercerts", - - insights: true, - }, - docs: { - sidebar: { - hideable: true, - autoCollapseCategories: false, - }, - }, - navbar: { - title: "hypercerts", - items: [ - { - type: "doc", - docId: "intro", - position: "left", - label: "Docs", - }, - { - type: "doc", - docId: "about", - position: "right", - label: "About", - }, - { - type: "dropdown", - label: "Community", - position: "right", - items: [ - { - label: "Twitter", - href: "https://twitter.com/hypercerts", - }, - { - label: "Telegram Group", - href: "https://t.me/+YF9AYb6zCv1mNDJi", - }, - ], - }, - { - href: "https://github.com/hypercerts-org/hypercerts", - label: "GitHub", - position: "right", - }, - { - type: "docsVersionDropdown", - position: "right", - }, - ], - }, - footer: { - style: "dark", - copyright: `Copyright © 2023 Hypercerts Foundation. Built with Docusaurus.`, - }, - prism: { - theme: themes.github, - darkTheme: themes.dracula, - }, - mermaid: { - theme: { light: "neutral", dark: "dark" }, - }, - }, - }; -} diff --git a/docs/package.json b/docs/package.json deleted file mode 100644 index 44464921..00000000 --- a/docs/package.json +++ /dev/null @@ -1,56 +0,0 @@ -{ - "name": "@hypercerts-org/docs", - "version": "1.1.0", - "license": "Apache-2.0", - "private": false, - "scripts": { - "docusaurus": "docusaurus", - "start": "docusaurus start", - "build": "docusaurus build", - "swizzle": "docusaurus swizzle", - "deploy": "docusaurus deploy", - "clear": "docusaurus clear", - "serve": "docusaurus serve", - "version:new": "docusaurus docs:version", - "write-translations": "docusaurus write-translations", - "write-heading-ids": "docusaurus write-heading-ids", - "typecheck": "tsc" - }, - "dependencies": { - "@docusaurus/core": "^3.0.0", - "@docusaurus/preset-classic": "^3.0.0", - "@docusaurus/theme-mermaid": "^3.0.0", - "@mdx-js/react": "^3.0.0", - "clsx": "^1.2.1", - "docusaurus-plugin-remote-content": "^3.1.0", - "docusaurus-plugin-typedoc": "^0.21.0", - "mdx-mermaid": "^2.0.0", - "mermaid": "^9.3.0", - "prism-react-renderer": "^2.1.0", - "react": "^18.2.0", - "react-dom": "^18.2.0" - }, - "devDependencies": { - "@docusaurus/eslint-plugin": "^3.0.0", - "@docusaurus/module-type-aliases": "^3.0.0", - "@docusaurus/tsconfig": "3.0.0", - "@docusaurus/types": "3.0.0", - "typescript": "^5.0.0" - }, - "browserslist": { - "production": [ - ">0.5%", - "not dead", - "not op_mini all" - ], - "development": [ - "last 1 chrome version", - "last 1 firefox version", - "last 1 safari version" - ] - }, - "engines": { - "node": ">=18.0" - }, - "packageManager": "pnpm@9.2.0+sha256.94fab213df221c55b6956b14a2264c21c6203cca9f0b3b95ff2fe9b84b120390" -} diff --git a/docs/sidebars.js b/docs/sidebars.js deleted file mode 100644 index 9b098caa..00000000 --- a/docs/sidebars.js +++ /dev/null @@ -1,180 +0,0 @@ -/** - * Creating a sidebar enables you to: - - create an ordered group of docs - - render a sidebar for each doc of that group - - provide next/previous navigation - - The sidebars can be generated from the filesystem, or explicitly defined here. - - Create as many sidebars as you want. - */ - -// @ts-check - -/** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */ -const sidebars = { - mySidebar: [ - { - type: "category", - label: "Announcements", - collapsed: true, - items: [ - { - type: "autogenerated", - dirName: "announcements", - }, - ], - }, - { - type: "doc", - id: "intro", - }, - { - type: "category", - label: "Vision & Whitepaper", - collapsed: true, - items: [ - { - type: "doc", - id: "whitepaper/whitepaper-intro", - }, - { - type: "doc", - id: "whitepaper/ifs", - }, - { - type: "doc", - id: "whitepaper/hypercerts-intro", - }, - { - type: "doc", - id: "whitepaper/impact-space", - }, - { - type: "doc", - id: "whitepaper/retrospective-funding", - }, - ], - }, - { - type: "category", - label: "Developer Guide", - collapsed: true, - items: [ - { - type: "doc", - id: "developer/quickstart-javascript", - }, - { - type: "doc", - id: "developer/quickstart-solidity", - }, - { - type: "doc", - id: "developer/minting", - }, - { - type: "doc", - id: "developer/allowlists", - }, - { - type: "doc", - id: "developer/querying", - }, - { - type: "doc", - id: "developer/split-merge", - }, - { - type: "doc", - id: "developer/burning", - }, - { - type: "doc", - id: "developer/supported-networks", - }, - { - type: "doc", - id: "devops/index", - }, - { - type: "category", - label: "API Reference", - collapsed: true, - items: [ - { - type: "category", - label: "Contracts", - collapsed: true, - items: [ - { - type: "autogenerated", - dirName: "developer/api/contracts", - }, - ], - }, - { - type: "category", - label: "SDK", - collapsed: true, - items: [ - { - type: "autogenerated", - dirName: "developer/api/sdk", - }, - ], - }, - ], - }, - ], - }, - { - type: "category", - label: "Minting Guide", - collapsed: true, - items: [ - { - type: "doc", - id: "minting-guide/minting-guide-start", - }, - { - type: "doc", - id: "minting-guide/step-by-step", - }, - { - type: "doc", - id: "minting-guide/gitcoin-round", - }, - ], - }, - { - type: "category", - label: "Implementation", - collapsed: true, - items: [ - { - type: "doc", - id: "implementation/token-standard", - }, - { - type: "doc", - id: "implementation/metadata", - }, - { - type: "doc", - id: "implementation/glossary", - }, - ], - }, - { - type: "doc", - id: "faq", - }, - { - type: "doc", - id: "further-resources", - }, - ], -}; - -module.exports = sidebars; diff --git a/docs/src/components/homepage/homeNavBoxes.js b/docs/src/components/homepage/homeNavBoxes.js deleted file mode 100644 index dab34160..00000000 --- a/docs/src/components/homepage/homeNavBoxes.js +++ /dev/null @@ -1,96 +0,0 @@ -import React from "react"; -import clsx from "clsx"; -import styles from "./homeNavBoxes.module.css"; - -const FeatureList = [ - { - title: "Introduction", - icon: "img/icons/hypercerts_logo_green.png", - items: [ - { url: "intro", text: "What are hypercerts?" }, - { url: "about", text: "About the Hypercerts Foundation" }, - { url: "faq", text: "Frequently Asked Questions" }, - { url: "further-resources", text: "Further Resources" }, - ], - }, - { - title: "Vision & Whitepaper", - icon: "img/icons/hypercerts_logo_beige.png", - items: [ - { url: "whitepaper/whitepaper-intro", text: "Introduction" }, - { url: "whitepaper/ifs", text: "Impact Funding Systems (IFSs)" }, - { - url: "whitepaper/hypercerts-intro", - text: "Hypercerts: a New Primitive", - }, - { url: "whitepaper/impact-space", text: "A Consistent Impact Space" }, - { url: "whitepaper/evaluations", text: "Open Impact Evaluations" }, - { - url: "whitepaper/retrospective-funding", - text: "Retrospective Impact Funding", - }, - ], - }, - { - title: "Minting Guide", - icon: "img/icons/hypercerts_logo_red.png", - items: [ - { url: "minting-guide/minting-guide-start", text: "Getting Started" }, - { url: "minting-guide/step-by-step", text: "Step-by-step Instructions" }, - { - url: "minting-guide/gitcoin-round", - text: "Gitcoin Alpha Round Instructions", - }, - ], - }, - { - title: "Developers", - icon: "img/icons/hypercerts_logo_yellow.png", - items: [ - { url: "developer", text: "Developer docs" }, - { url: "implementation/token-standard", text: "Token Standard" }, - { url: "implementation/metadata", text: "Metadata Standard" }, - { url: "implementation/glossary", text: "Glossary" }, - ], - }, -]; - -function FeatureItem({ url, text }) { - return ( -
  • - - {text} - -
    • - ); -} - -function Feature({ title, icon, items }) { - return ( -
    -
    - -

    {title}

    -
    -
      - {items.map((props, idx) => ( - - ))} -
    -
    -
    -
    - ); -} - -export default function HomepageFeatures() { - return ( -
    -
      - {FeatureList.map((props, idx) => ( - - ))} -
    -
    - ); -} diff --git a/docs/src/components/homepage/homeNavBoxes.module.css b/docs/src/components/homepage/homeNavBoxes.module.css deleted file mode 100644 index beb95f39..00000000 --- a/docs/src/components/homepage/homeNavBoxes.module.css +++ /dev/null @@ -1,121 +0,0 @@ -.features { - display: flex; - align-items: center; - padding: 2rem 0; - width: 100%; -} - -.featureSvg { - height: 200px; - width: 200px; -} - - -.grid3col{ - display: grid; - grid-template-columns: repeat(4,minmax(0,1fr)); - gap:20px; - margin: 0 auto; - padding: 0; -} -@media screen and (max-width: 1680px) { - .grid3col{ - display: grid; - grid-template-columns: repeat(2,minmax(0,1fr)); - gap:20px; - margin: 0 auto; - } -} -@media screen and (max-width: 1450px) { - .grid3col{ - display: grid; - grid-template-columns: repeat(2,minmax(0,1fr)); - gap:20px; - margin: 0 auto; - } -} -@media screen and (max-width: 1180px) { - .grid3col{ - display: grid; - grid-template-columns: repeat(2,minmax(0,1fr)); - gap:20px; - margin: 0 auto; - } -} -@media screen and (max-width: 768px) { - .grid3col{ - display: grid; - grid-template-columns: repeat(1,minmax(0,1fr)); - gap:10px 0px; - margin: 0 auto; - } -} - - -.listContainer{ - min-height: 13rem; -} -@media screen and (max-width: 768px) { - .listContainer{ - min-height: 3rem; - padding-bottom: 1rem; - } -} -.listContainer li{ - list-style-type: none; - position: relative; -} - -.listContainer li:before{ - --ifm-menu-link-sublist-icon: url('data:image/svg+xml;utf8,'); - background: var(--ifm-menu-link-sublist-icon) 50% / 1.25rem 1.25rem; - transform: rotate(90deg); - content: ''; - position: absolute; - height: 1.25rem; - width: 1.25rem; - left: -1.5rem; - top: 0.5rem; - } - -.homecard{ - background-color: #1c1f26; - width: 320px; - padding: 8px; - position: relative; - display: block; - border-radius: 16px; - border: 1px solid #a8b3cf33; -} - -html[data-theme='light'] .homecard{ - background-color: #fff; - border: 1px solid #a8b3cf; - color: #000; -} - - -.homecard h2{ - margin: 8px 16px; - min-height: 2.4rem; - font-size: 1.25rem; - line-height: 1.4; -} - -html[data-theme='light'] .homecard a{ - color: #000; -} -.homecard a{ - color: white; - text-decoration: underline; - line-height: 2rem;; -} -html[data-theme='light'] .homeIcon{ - filter: brightness(0.5); -} -.homeIcon{ - width: 28px; - height: 28px; - border-radius: 0!important; - margin: 12px 0 4px 16px; -} diff --git a/docs/src/css/custom.css b/docs/src/css/custom.css deleted file mode 100644 index 79b49a61..00000000 --- a/docs/src/css/custom.css +++ /dev/null @@ -1,44 +0,0 @@ -/** - * Any CSS included here will be global. The classic template - * bundles Infima by default. Infima is a CSS framework designed to - * work well for content-centric websites. - */ - -/* You can override the default Infima variables here. */ -:root { - --ifm-color-primary: #2e8555; - --ifm-color-primary-dark: #29784c; - --ifm-color-primary-darker: #277148; - --ifm-color-primary-darkest: #205d3b; - --ifm-color-primary-light: #33925d; - --ifm-color-primary-lighter: #359962; - --ifm-color-primary-lightest: #3cad6e; - --ifm-code-font-size: 95%; - --docusaurus-highlighted-code-line-bg: rgba(0, 0, 0, 0.1); -} - -/* For readability concerns, you should choose a lighter palette in dark mode. */ -[data-theme="dark"] { - --ifm-color-primary: #25c2a0; - --ifm-color-primary-dark: #21af90; - --ifm-color-primary-darker: #1fa588; - --ifm-color-primary-darkest: #1a8870; - --ifm-color-primary-light: #29d5b0; - --ifm-color-primary-lighter: #32d8b4; - --ifm-color-primary-lightest: #4fddbf; - --docusaurus-highlighted-code-line-bg: rgba(0, 0, 0, 0.3); -} - -iframe.slides { - aspect-ratio: 1.687; - width: 100%; - height: auto; -} - -svg[id*=mermaid]{ - height: auto !important; -} - -dt { - margin-top: 20px; -} diff --git a/docs/src/pages/index.js b/docs/src/pages/index.js deleted file mode 100644 index 7a8e73c8..00000000 --- a/docs/src/pages/index.js +++ /dev/null @@ -1,36 +0,0 @@ -import React from 'react'; -import clsx from 'clsx'; -import Layout from '@theme/Layout'; -import Link from '@docusaurus/Link'; -import useDocusaurusContext from '@docusaurus/useDocusaurusContext'; -import styles from './video.module.css'; -import HomeNavBoxes from '../components/homepage/homeNavBoxes'; -import { Redirect } from '@docusaurus/router'; - -function HomepageHeader() { - const { siteConfig } = useDocusaurusContext(); - return ( - -
    -
    -

    hypercerts docs

    -
    -
    - ); -} - -export default function Home() { - const { siteConfig } = useDocusaurusContext(); - - // return ; - return ( - - -
    - -
    -     - ); -} diff --git a/docs/src/pages/index.module.css b/docs/src/pages/index.module.css deleted file mode 100644 index 6fe64b96..00000000 --- a/docs/src/pages/index.module.css +++ /dev/null @@ -1,25 +0,0 @@ -/** - * CSS files with the .module.css suffix will be treated as CSS modules - * and scoped locally. - */ - -.heroBanner { - padding: 4rem 0; - text-align: center; - position: relative; - overflow: hidden; -} - -@media screen and (max-width: 966px) { - .heroBanner { - padding: 2rem; - } -} - - - -.buttons { - display: flex; - align-items: center; - justify-content: center; -} diff --git a/docs/src/pages/video.module.css b/docs/src/pages/video.module.css deleted file mode 100644 index 186711d2..00000000 --- a/docs/src/pages/video.module.css +++ /dev/null @@ -1,17 +0,0 @@ -/** - * CSS files with the .module.css suffix will be treated as CSS modules - * and scoped locally. - */ - -.heroBanner { - padding: 2rem 0 0 0; - text-align: center; - position: relative; - overflow: hidden; -} - -@media screen and (max-width: 966px) { - .heroBanner { - padding: 2rem; - } -} diff --git a/docs/static/.nojekyll b/docs/static/.nojekyll deleted file mode 100644 index e69de29b..00000000 diff --git a/docs/static/img/creating.png b/docs/static/img/creating.png deleted file mode 100644 index 17807cd3..00000000 Binary files a/docs/static/img/creating.png and /dev/null differ diff --git a/docs/static/img/docusaurus.png b/docs/static/img/docusaurus.png deleted file mode 100644 index f458149e..00000000 Binary files a/docs/static/img/docusaurus.png and /dev/null differ diff --git a/docs/static/img/favicon.ico b/docs/static/img/favicon.ico deleted file mode 100644 index 576d606a..00000000 Binary files a/docs/static/img/favicon.ico and /dev/null differ diff --git a/docs/static/img/hypercert_data_layer.png b/docs/static/img/hypercert_data_layer.png deleted file mode 100644 index 6978885f..00000000 Binary files a/docs/static/img/hypercert_data_layer.png and /dev/null differ diff --git a/docs/static/img/hypercert_evaluations.png b/docs/static/img/hypercert_evaluations.png deleted file mode 100644 index fe824d5f..00000000 Binary files a/docs/static/img/hypercert_evaluations.png and /dev/null differ diff --git a/docs/static/img/hypercert_example.png b/docs/static/img/hypercert_example.png deleted file mode 100644 index be9b9155..00000000 Binary files a/docs/static/img/hypercert_example.png and /dev/null differ diff --git a/docs/static/img/hypercert_id.png b/docs/static/img/hypercert_id.png deleted file mode 100644 index 05b82081..00000000 Binary files a/docs/static/img/hypercert_id.png and /dev/null differ diff --git a/docs/static/img/hypercert_tech_report.png b/docs/static/img/hypercert_tech_report.png deleted file mode 100644 index 67b9a1a6..00000000 Binary files a/docs/static/img/hypercert_tech_report.png and /dev/null differ diff --git a/docs/static/img/icons/beige.svg b/docs/static/img/icons/beige.svg deleted file mode 100644 index 65376c72..00000000 --- a/docs/static/img/icons/beige.svg +++ /dev/null @@ -1,3 +0,0 @@ - - - diff --git a/docs/static/img/icons/github-mark.png b/docs/static/img/icons/github-mark.png deleted file mode 100644 index 6cb3b705..00000000 Binary files a/docs/static/img/icons/github-mark.png and /dev/null differ diff --git a/docs/static/img/icons/green.svg b/docs/static/img/icons/green.svg deleted file mode 100644 index d23f2ee0..00000000 --- a/docs/static/img/icons/green.svg +++ /dev/null @@ -1,3 +0,0 @@ - - - diff --git a/docs/static/img/icons/hypercerts_logo_beige.png b/docs/static/img/icons/hypercerts_logo_beige.png deleted file mode 100644 index eac7eefb..00000000 Binary files a/docs/static/img/icons/hypercerts_logo_beige.png and /dev/null differ diff --git a/docs/static/img/icons/hypercerts_logo_green.png b/docs/static/img/icons/hypercerts_logo_green.png deleted file mode 100644 index 3f114385..00000000 Binary files a/docs/static/img/icons/hypercerts_logo_green.png and /dev/null differ diff --git a/docs/static/img/icons/hypercerts_logo_red.png b/docs/static/img/icons/hypercerts_logo_red.png deleted file mode 100644 index caa11af9..00000000 Binary files a/docs/static/img/icons/hypercerts_logo_red.png and /dev/null differ diff --git a/docs/static/img/icons/hypercerts_logo_yellow.png b/docs/static/img/icons/hypercerts_logo_yellow.png deleted file mode 100644 index c83726fb..00000000 Binary files a/docs/static/img/icons/hypercerts_logo_yellow.png and /dev/null differ diff --git a/docs/static/img/icons/red.svg b/docs/static/img/icons/red.svg deleted file mode 100644 index 0d2adb64..00000000 --- a/docs/static/img/icons/red.svg +++ /dev/null @@ -1,3 +0,0 @@ - - - diff --git a/docs/static/img/icons/yellow.svg b/docs/static/img/icons/yellow.svg deleted file mode 100644 index cbe666e7..00000000 --- a/docs/static/img/icons/yellow.svg +++ /dev/null @@ -1,3 +0,0 @@ - - - diff --git a/docs/static/img/increasing_rewards.png b/docs/static/img/increasing_rewards.png deleted file mode 100644 index 6d6e6ca0..00000000 Binary files a/docs/static/img/increasing_rewards.png and /dev/null differ diff --git a/docs/static/img/logo.svg b/docs/static/img/logo.svg deleted file mode 100644 index 9db6d0d0..00000000 --- a/docs/static/img/logo.svg +++ /dev/null @@ -1 +0,0 @@ - \ No newline at end of file diff --git a/docs/static/img/merging.png b/docs/static/img/merging.png deleted file mode 100644 index 4ae1679f..00000000 Binary files a/docs/static/img/merging.png and /dev/null differ diff --git a/docs/static/img/retrospective_funding.png b/docs/static/img/retrospective_funding.png deleted file mode 100644 index 2a634e6f..00000000 Binary files a/docs/static/img/retrospective_funding.png and /dev/null differ diff --git a/docs/static/img/splitting.png b/docs/static/img/splitting.png deleted file mode 100644 index 19c15a31..00000000 Binary files a/docs/static/img/splitting.png and /dev/null differ diff --git a/docs/static/img/undraw_docusaurus_mountain.svg b/docs/static/img/undraw_docusaurus_mountain.svg deleted file mode 100644 index af961c49..00000000 --- a/docs/static/img/undraw_docusaurus_mountain.svg +++ /dev/null @@ -1,171 +0,0 @@ - - Easy to Use - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/static/img/undraw_docusaurus_react.svg b/docs/static/img/undraw_docusaurus_react.svg deleted file mode 100644 index 94b5cf08..00000000 --- a/docs/static/img/undraw_docusaurus_react.svg +++ /dev/null @@ -1,170 +0,0 @@ - - Powered by React - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/static/img/undraw_docusaurus_tree.svg b/docs/static/img/undraw_docusaurus_tree.svg deleted file mode 100644 index d9161d33..00000000 --- a/docs/static/img/undraw_docusaurus_tree.svg +++ /dev/null @@ -1,40 +0,0 @@ - - Focus on What Matters - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/static/pdf/hypercerts_Tech_Report_draft.pdf b/docs/static/pdf/hypercerts_Tech_Report_draft.pdf deleted file mode 100644 index 3f5f6fc3..00000000 Binary files a/docs/static/pdf/hypercerts_Tech_Report_draft.pdf and /dev/null differ diff --git a/docs/static/pdf/hypercerts_slides_FtC202203.pdf b/docs/static/pdf/hypercerts_slides_FtC202203.pdf deleted file mode 100644 index 0ea059ce..00000000 Binary files a/docs/static/pdf/hypercerts_slides_FtC202203.pdf and /dev/null differ diff --git a/docs/static/pdf/hypercerts_slides_FtC202206.pdf b/docs/static/pdf/hypercerts_slides_FtC202206.pdf deleted file mode 100644 index 821f8c44..00000000 Binary files a/docs/static/pdf/hypercerts_slides_FtC202206.pdf and /dev/null differ diff --git a/docs/static/pdf/hypercerts_whitepaper_v0.pdf b/docs/static/pdf/hypercerts_whitepaper_v0.pdf deleted file mode 100644 index 930fbbbd..00000000 Binary files a/docs/static/pdf/hypercerts_whitepaper_v0.pdf and /dev/null differ diff --git a/docs/tsconfig.json b/docs/tsconfig.json deleted file mode 100644 index 6f475698..00000000 --- a/docs/tsconfig.json +++ /dev/null @@ -1,7 +0,0 @@ -{ - // This file is not used in compilation. It is here just for a nice editor experience. - "extends": "@tsconfig/docusaurus/tsconfig.json", - "compilerOptions": { - "baseUrl": "." - } -} diff --git a/e2e/fixtures/metamask.ts b/e2e/fixtures/metamask.ts deleted file mode 100644 index e2bcfc7e..00000000 --- a/e2e/fixtures/metamask.ts +++ /dev/null @@ -1,62 +0,0 @@ -import { test as base, chromium, type BrowserContext } from "@playwright/test"; -import { initialSetup } from "@synthetixio/synpress/commands/metamask"; -import { prepareMetamask } from "@synthetixio/synpress/helpers"; -import { - FRONTEND_HOST, - FRONTEND_PORT, - FRONTEND_RPC_HOST, - FRONTEND_RPC_PORT, -} from "../utils/constants"; - -export const test = base.extend<{ - context: BrowserContext; -}>({ - // eslint-disable-next-line - context: async ({}, use) => { - // required for synpress - global.expect = expect; - // download metamask - const metamaskPath = await prepareMetamask( - process.env.METAMASK_VERSION || "10.25.0", - ); - // prepare browser args - const browserArgs = [ - `--disable-extensions-except=${metamaskPath}`, - `--load-extension=${metamaskPath}`, - "--remote-debugging-port=9222", - ]; - if (process.env.CI) { - browserArgs.push("--disable-gpu"); - } - if (process.env.HEADLESS_MODE) { - browserArgs.push("--headless=new"); - } - // launch browser - const context = await chromium.launchPersistentContext("", { - headless: false, - args: browserArgs, - baseURL: `http://${FRONTEND_HOST}:${FRONTEND_PORT}`, - }); - // wait for metamask - await context.pages()[0].waitForTimeout(10000); - - // setup metamask - await initialSetup(chromium, { - secretWordsOrPrivateKey: - "test test test test test test test test test test test junk", - network: { - name: "hardhat", - chainId: 31337, - rpcUrl: `http://${FRONTEND_RPC_HOST}:${FRONTEND_RPC_PORT}`, - symbol: "TEST", - isTestnet: true, - }, - password: "Tester@1234", - enableAdvancedSettings: true, - enableExperimentalSettings: false, - }); - await use(context); - await context.close(); - }, -}); -export const expect = test.expect; diff --git a/e2e/mint-token.spec.ts b/e2e/mint-token.spec.ts deleted file mode 100644 index fc37bcd6..00000000 --- a/e2e/mint-token.spec.ts +++ /dev/null @@ -1,75 +0,0 @@ -import { test, expect } from "./fixtures/metamask"; -import { Page } from "@playwright/test"; -import * as metamask from "@synthetixio/synpress/commands/metamask"; -import { randomUUID } from "crypto"; - -async function navigateAndEnsureWallet(goto: string, page: Page) { - await page.goto(goto); - await expect( - page.locator('button[data-testid="rk-account-button"]'), - ).toBeAttached({ timeout: 5000 }); -} - -test.beforeEach(async ({ page }) => { - // These are very large tests we should have a long timeout this time out is - // for specific actions on the page. It can probably tweaked to be faster but - // our github runners aren't so fast. - page.setDefaultTimeout(60000); - - await page.goto("/"); - await page.reload(); - await page.locator('button[data-testid="rk-connect-button"]').click(); - - await page.locator('button[data-testid="rk-wallet-option-metaMask"]').click(); - await metamask.acceptAccess(); -}); - -test("should succeed to mint a token", async ({ page }) => { - const testUUID = randomUUID(); - const name = `Test:${testUUID}`; - const description = "This is a description of the hypercert is referencing"; - const workScope = "Scope1, Scope2"; - const contributors = "Contrib1, Contrib2"; - - // Clicking to navigate to the "/app/create" path caused problems. For now, - // ignore clicking on the links with the prefilled fields - await navigateAndEnsureWallet("/app/create", page); - - // Fill in required fields - await page.locator('input[name="name"]').fill(name); - await page.locator('textarea[name="description"]').fill(description); - await page.locator('textarea[name="workScopes"]').fill(workScope); - await page.locator('textarea[name="contributors"]').fill(contributors); - - // Check boxes - await page.locator('input[name="agreeContributorsConsent"]').check(); - await page.locator('input[name="agreeTermsConditions"]').check(); - await page.locator('button[class*="HypercertsCreate__createButton"]').click(); - await metamask.confirmTransaction(); - - await page.waitForURL("/app/dashboard"); - await expect(page.getByText(testUUID)).toBeAttached({ timeout: 60000 }); -}); - -test("should fail to mint a token - lacking description", async ({ page }) => { - const testUUID = randomUUID(); - const name = `Test:${testUUID}`; - const description = "This is a description of the hypercert is referencing"; - const workScope = "Scope1, Scope2"; - const contributors = ""; - - await navigateAndEnsureWallet("/app/create", page); - await page.locator('input[name="name"]').fill(name); - await page.locator('textarea[name="description"]').fill(description); - await page.locator('textarea[name="workScopes"]').fill(workScope); - - await page.locator('textarea[name="contributors"]').fill(contributors); - await page.locator('input[name="agreeContributorsConsent"]').check(); - await page.locator('input[name="agreeTermsConditions"]').check(); - await page.locator('button[class*="HypercertsCreate__createButton"]').click(); - - await expect(page.locator('textarea[name="contributors"]')).toHaveAttribute( - "aria-invalid", - "true", - ); -}); diff --git a/e2e/utils/constants.ts b/e2e/utils/constants.ts deleted file mode 100644 index 52317dbc..00000000 --- a/e2e/utils/constants.ts +++ /dev/null @@ -1,14 +0,0 @@ -import { Page } from "playwright-core"; - -export const FRONTEND_HOST = process.env.FRONTEND_HOST || "127.0.0.1"; -export const FRONTEND_PORT = process.env.FRONTEND_PORT || "3000"; -export const FRONTEND_RPC_HOST = process.env.FRONTEND_RPC_HOST || "127.0.0.1"; -export const FRONTEND_RPC_PORT = process.env.FRONTEND_RPC_PORT || "8545"; - -export async function gotoPage(page: Page, path: string) { - return await page.goto(fullUrl(path)); -} - -export function fullUrl(path: string) { - return `http://${FRONTEND_HOST}:${FRONTEND_PORT}${path}`; -} diff --git a/frontend/.env.local.example b/frontend/.env.local.example deleted file mode 100644 index 6db8ed46..00000000 --- a/frontend/.env.local.example +++ /dev/null @@ -1,24 +0,0 @@ -############# -## App config -############# -### The domain that the application is hosted on -NEXT_PUBLIC_DOMAIN=testnet.hypercerts.org - -####### -## Web3 -####### -### UUPS proxy contract address -NEXT_PUBLIC_CONTRACT_ADDRESS=0xa16DFb32Eb140a6f3F2AC68f41dAd8c7e83C4941 -### Subgraph URL - currently using hosted service -NEXT_PUBLIC_GRAPH_URL=https://api.thegraph.com/subgraphs/name/hypercerts-admin/hypercerts-sepolia -### Wallet connect ID -NEXT_PUBLIC_WALLETCONNECT_ID=GET_FROM_https://cloud.walletconnect.com/app - -########## -## Storage -########## -NEXT_PUBLIC_WEB3_STORAGE_TOKEN=YOUR_API_KEY -NEXT_PUBLIC_NFT_STORAGE_TOKEN=YOUR_API_KEY -NEXT_PUBLIC_SUPABASE_URL=https://YOUR_SUPABASE_URL -NEXT_PUBLIC_SUPABASE_ANON_KEY=YOUR_SUPABASE_ANON_KEY -NEXT_PUBLIC_SUPABASE_TABLE=YOUR_SUPABASE_TABLE \ No newline at end of file diff --git a/frontend/.eslintrc.json b/frontend/.eslintrc.json deleted file mode 100644 index fdcf77c2..00000000 --- a/frontend/.eslintrc.json +++ /dev/null @@ -1,33 +0,0 @@ -{ - "env": { - "browser": true, - "es2021": true, - "node": true - }, - "settings": { - "next": { - "rootDir": "./" - } - }, - "extends": [ - "eslint:recommended", - "plugin:react/recommended", - "plugin:@typescript-eslint/recommended", - "prettier", - "next" - ], - "parser": "@typescript-eslint/parser", - "parserOptions": { - "ecmaFeatures": { - "jsx": true - }, - "ecmaVersion": "latest", - "sourceType": "module" - }, - "plugins": ["react", "@typescript-eslint"], - "rules": { - "react-hooks/exhaustive-deps": "off", - "@typescript-eslint/no-explicit-any": "off", - "@typescript-eslint/no-unused-vars": ["warn", { "argsIgnorePattern": "^_" }] - } -} diff --git a/frontend/.gitignore b/frontend/.gitignore deleted file mode 100644 index 44f9bd5b..00000000 --- a/frontend/.gitignore +++ /dev/null @@ -1,13 +0,0 @@ -# next.js -/.next/ -/out/ - -# vercel -.vercel - -# Sentry -.sentryclirc - -/**/node_modules/* -node_modules/ -../node_modules/ diff --git a/frontend/README.md b/frontend/README.md deleted file mode 100644 index 4c8bac0a..00000000 --- a/frontend/README.md +++ /dev/null @@ -1,78 +0,0 @@ -# Frontend application - -This frontend application is currently configured to use Next.js as a static site generator so that we can easily port the site hosting to any CDN. If we need server-side features (e.g. image optimization, SSR, etc), we can easily add those features later. - -## Set up - -All configurations are currently stored in environment variables. -See `.env.local.example` to see which variables need to be set. -We have pre-populated the file with the current testnet deployment on Sepolia. - -The easiest way to get started is to copy this into `.env.local` and modify the file directly, which `next` will automatically load when running the dev server below. - -Note to developers: if you add or remove environment variables, make sure you update - -- `.env.local.example` -- `./lib/config.ts` -- `../.github/workflows/ci-default.yml` -- Any CI/CD system (e.g. GitHub Actions, Pages) -- In your organization's secrets manager - -### Plasmic - -We use a no-code visual builder for React called [Plasmic](https://www.plasmic.app?ref=ryscheng). You can sign up for an account [here](https://www.plasmic.app?ref=ryscheng). - -After signing up, you can check out the frontend [here](https://studio.plasmic.app/projects/bRx6ZFJBJ4PzQ8sSaLn1xW?ref=ryscheng). You will have read-only access to this project. - -If you need to make edits, you can duplicate the project and update your project ID and API key in `.env.local`. For more information on setting up Plasmic, check out their [docs](https://docs.plasmic.app/learn/nextjs-quickstart). - -### Web3 providers - -Set up an account with a web3 provider like [Alchemy](https://alchemy.com/?r=17b797341eddfeda). Create a new application on Alchemy and set your `NEXT_PUBLIC_RPC_URL` environment variable. - -### IPFS - -We use [web3.storage](https://web3.storage/) for general blob storage and [nft.storage](https://nft.storage/) for storing token metadata. - -Sign up for accounts and populate the `NEXT_PUBLIC_WEB3_STORAGE_TOKEN` and `NEXT_PUBLIC_NFT_STORAGE_TOKEN` environment variables with your API keys. For more information, you can check out their docs -([web3.storage](https://web3.storage/docs/), [nft.storage](https://nft.storage/docs/)). - -### Supabase - -We use [Supabase](https://supabase.com/) only as a non-essential cache. -In the future, we will either remove this dependency or add instructions on how to setup a local instance for development. -In the meantime, the app should still build with the placeholder values. - -## Run development server - -``` -yarn dev -``` - -Visit on `http://localhost:3000/` - -## Testing - -To run linters: - -``` -yarn lint -``` - -To run unit tests: - -``` -yarn test -``` - -## Build and export - -This repository is currently set up to export to a static site: - -``` -yarn build -``` - -This will place the static site in `/frontend/out`, which can be uploaded to any CDN or IPFS for hosting. - -Note: This means that we do not currently use any server-side or edge functionality (e.g. middleware, SSR, image optimization etc) diff --git a/frontend/_redirects b/frontend/_redirects deleted file mode 100644 index 4d85d2bd..00000000 --- a/frontend/_redirects +++ /dev/null @@ -1,2 +0,0 @@ -/discord https://discord.gg/UZt8cBnP4w -/telegram https://t.me/+YF9AYb6zCv1mNDJi \ No newline at end of file diff --git a/frontend/components/add-registry-dialog.tsx b/frontend/components/add-registry-dialog.tsx deleted file mode 100644 index 27830d93..00000000 --- a/frontend/components/add-registry-dialog.tsx +++ /dev/null @@ -1,43 +0,0 @@ -import { - Button, - Dialog, - DialogContent, - DialogProps, - DialogTitle, -} from "@mui/material"; -import { Formik } from "formik"; - -export const AddRegistryDialog = (props: DialogProps) => { - return ( - - Add registry - - { - console.log(data); - }} - > - {({ handleSubmit }) => ( -
    - - - -