Taskfile.yml

---
version: "3"

vars:
  CURL_CICD_DEV: "curl -s -H 'Accept: application/vnd.github.v3.raw' -L https://api.github.com/repos/polysensus/cicd-dev-infra/contents"
  TUSKS: "{{.ROOT_DIR}}/.local/dev"
  FACETS_EXCLUDE: "{{.ROOT_DIR}}/node_modules/@polysensus/chaintrap-contracts/abi/facets-exclude.json"
  FACETS_DEPLOYED: "facets-deployed.json"
  CHAINTRAP_CONTRACTS_ABI_DIR: "{{.ROOT_DIR}}/node_modules/@polysensus/chaintrap-contracts/abi"
  DIAMOND_DEPLOY_JSON: "{{.ROOT_DIR}}/.local/dev/diamond-deploy.json"
  DEPLOYCLI: "node {{.ROOT_DIR}}/node_modules/@polysensus/diamond-deploy/dist/deploycli.esm.js"
  #DEPLOYCLI: "node node_modules/@polysensus/diamond-deploy/deploycli.js"
  FURNITURE_FILE: "{{.ROOT_DIR}}/data/maps/map02-furnishings.json"
  MAP_FILE: "{{.ROOT_DIR}}/data/maps/map02.json"
  MAP_NAME: "map02"
  CODEX_FILENAME: "map02.codex.json"
  CODEX_PASSWORD: "very-secret"
  OPENAI_IMAGE_PROMPT: "A stylised icon representing a turn based random dungeon crawler game"
  PROVIDER_ID: '{{.PROVIDER_ID | default "hh"}}'

includes:
  op:game:
    taskfile: ./taskfiles/Taskfile_game.yml
    vars:
      PROVIDER_ID: "opsepolia"
  hh:game:
    taskfile: ./taskfiles/Taskfile_game.yml
    vars:
      PROVIDER_ID: "hh"

  # ----
  # Milestone demos
  # ----
  hh:cms3:
    taskfile: ./taskfiles/Taskfile_cms3.yml
    vars:
      PROVIDER_ID: "hh"
  op:cms3:
    taskfile: ./taskfiles/Taskfile_cms3.yml
    vars:
      PROVIDER_ID: "op"

  hh:cms4:
    taskfile: ./taskfiles/Taskfile_cms3.yml
    vars:
      PROVIDER_ID: "hh"
  op:cms4:
    taskfile: ./taskfiles/Taskfile_cms4.yml
    vars:
      PROVIDER_ID: "op"

tasks:
  bootstrap:
    desc: fetch the pre-requisites for all workflows
    cmds:
      - |
        mkdir -p {{.TUSKS}}
        cd {{.TUSKS}}
        {{.CURL_CICD_DEV}}/js/tusk-jspkg.yml?ref=v0.0.5 -o tusk-jspkg.yml
        {{.CURL_CICD_DEV}}/hardhat/tusk-hardhat.yml?ref=v0.0.5 -o tusk-hardhat.yml

  release:patch:
    desc: create patch release
    cmds:
      - |
        tusk -q -f {{.TUSKS}}/tusk-jspkg.yml version-update {{.CLI_ARGS}}

  fmt:
    - npm run format
  format:
    desc: automatic code formatting - run prettier and then lint
    cmds:
      - |
        npm run format
        npm run lint

  build:
    cmds:
      - task: build:js
      - task: build:diamond-deploy

  test:prepare:cd:
    desc: start hardhat and deploy contracts for CI/CD
    cmds:
      - task: test:prepare

  test:prepare:
    desc: start hardhat and deploy contracts for test:integ
    cmds:
      - |
        cat .env.example.hh | envsubst > .env.hh
        cat .env.hh | grep ARENASTATE_
      - task: dev:hh:restart
      - |
        task -s deploy:new PROVIDER_ID=hh -- --commit
        ADDRESS=$(task -s find PROVIDER_ID=hh)
        echo "# test:prepare:cd resolved the following address after deploying" >> .env.hh
        echo "export ARENASTATE_ARENA=${ADDRESS}" >> .env.hh
        cp .env.hh .env.test

  test:
    desc: run the unit tests
    cmds:
      - npx mocha './**/*.mocha.js' {{.CLI_ARGS}}

  build:js:
    desc: format and lint the code, then build the package
    deps: [format]
    cmds:
      - npm run build

  build:diamond-deploy:
    desc: generate the deployable list of facets
    cmds:
      - |
        mkdir -p .local/dev
        {{.DEPLOYCLI}} \
          list \
          -I facet -i {{.CHAINTRAP_CONTRACTS_ABI_DIR}} \
          --exclude {{.FACETS_EXCLUDE}} \
          -n Diamond DiamondNew \
          --format json | tee {{.DIAMOND_DEPLOY_JSON}}

  # ----
  # game commands
  # ----
  game:maptool:
    desc: load a map file and save it in a game codex
    dotenv: [".env.{{.PROVIDER_ID}}"]
    cmds:
      - |
        echo "PROVIDER_ID: {{.PROVIDER_ID}}"
        ./cli.js \
          --map-name {{.MAP_NAME}} \
          maptool \
            --map-load \
            --map-filename {{.MAP_FILE}} \
            --codex-filename {{.CODEX_FILENAME}} \
            --codex-password {{.CODEX_PASSWORD}}

  deploy:
    desc: deploy the contracts to all supported networks
    cmds:
      - task: deploy:new
        vars:
          PROVIDER_ID: "hh"
          COMMIT: "yes"
      - task: deploy:new
        vars:
          PROVIDER_ID: "caimst"
      - task: deploy:mumbai
      - task: deploy
        vars:
          PROVIDER_ID: opsepolia

  op:bridge-eth:
    dotenv: [".env.opsepolia"]
    desc: |
      bridge eth from Optimism L1 to L2.

      example use

        task op:bridge-eth -- $(cat .local/dev/wallets/wallet-deploy.key) 0.5 --commit
    cmds:
      - |
        echo needs porting from tusk syntax
        exit 1
        set -e
        ${diamond-deploy} \
          -u "${rpc}" \
          op-deposit \
            --l1-url=${l1-url} \
            --eth-fiat=1453 \
            --units=${units} \
            $(${commit} && echo -n '--commit' ) \
            ${key} ${amount}

  deploy:op:
    desc: deploy the contracts to optimism testnet
    cmds:
      - task: deploy:up
        vars:
          PROVIDER_ID: "opsepolia"
          GAS_PRICE: "0.001"

  deploy:op-new:
    desc: deploy the contracts to optimism testnet
    cmds:
      - task: deploy:new
        vars:
          PROVIDER_ID: "opsepolia"
          GAS_PRICE: "0.001"
          #GAS_LIMIT: "1514"
          #CUTTER_GAS_LIMIT: "1514"
          #GAS_LIMIT: "1514136"
          #CUTTER_GAS_LIMIT: "1514136"
          GAS_LIMIT: '{{.GAS_LIMIT | default ""}}'
          CUTTER_GAS_LIMIT: '{{.CUTTER_GAS_LIMIT | default ""}}'

  deploy:mumbai:
    desc: deploy the contracts to polygon mumbai testnet
    cmds:
      - task: deploy:up
        vars:
          PROVIDER_ID: "mumbai"
          GAS_PRICE: "2.6"

  deploy:mumbai-new:
    desc: deploy the contracts to polygon mumbai testnet
    cmds:
      - task: deploy:new
        vars:
          PROVIDER_ID: "mumbai"
          GAS_PRICE: "2.6"

  deploy:up:
    desc: |
      deploy the contracts to the chosen provider

      This command is dry run by default, add '-- --commit' to deploy
    dotenv: [".env.{{.PROVIDER_ID}}"]
    vars:
      PROVIDER_ID: '{{.PROVIDER_ID | default "hh"}}'
      GAS_PRICE: '{{.GAS_PRICE | default "0.001"}}'
      DIAMOND_ADDRESS: '{{.DIAMOND_ADDRESS | default ""}}'
      DIAMOND_NONCE: '{{.DIAMOND_NONCE | default ""}}'
      GAS_LIMIT: '{{.GAS_LIMIT | default ""}}'
      CUTTER_GAS_LIMIT: '{{.CUTTER_GAS_LIMIT | default ""}}'
      COMMIT: '{{.COMMIT | default ""}}'

    cmds:
      - |
        echo "ARENASTATE_DEPLOY_KEY: $ARENASTATE_DEPLOY_KEY"
        echo "PROVIDER_ID {{.PROVIDER_ID}}"
        echo "ARENASTATE_ARENA: $ARENASTATE_ARENA"
        DIAMOND_ADDRESS=${ARENASTATE_ARENA:-"{{.DIAMOND_ADDRESS}}"}
        echo "DIAMOND_ADDRESS: $DIAMOND_ADDRESS"
        DIAMOND_NONCE=${ARENASTATE_DIAMOND_NONCE:-"{{.DIAMOND_NONCE}}"}
        echo "DIAMOND_NONCE: $DIAMOND_NONCE"
        echo "GAS_PRICE: {{.GAS_PRICE}}"
        echo "GAS_PRICE: {{.GAS_LIMIT}}"
        echo "CUTTER_GAS_PRICE: {{.CUTTER_GAS_LIMIT}}"

        {{.DEPLOYCLI}} list \
          -I facet -n Diamond DiamondNew \
          -i node_modules/@polysensus/chaintrap-contracts/abi \
          --format json -x node_modules/@polysensus/chaintrap-contracts/abi/facets-exclude.json \
          > diamond-deploy.json

        {{.DEPLOYCLI}} \
          -u "${ARENASTATE_PROVIDER_URL}" \
          -d "${ARENASTATE_DEPLOY_KEY}" \
          diamond-up \
            $([ -n '{{.DIAMOND_NONCE}}' ] && echo -n '--diamond-nonce {{.DIAMOND_NONCE}}' ) \
            $([ -n '{{.DIAMOND_ADDRESS}}' ] && echo -n '--diamond-address {{.DIAMOND_ADDRESS}}' ) \
            --replace \
            $([ -n '{{.GAS_PRICE}}' ] && echo -n '--gasprice {{.GAS_PRICE}}' ) \
            $([ -n '{{.GAS_LIMIT}}' ] && echo -n '--gaslimit {{.GAS_LIMIT}}' ) \
            $([ -n '{{.CUTTER_GAS_LIMIT}}' ] && echo -n '--cutter-gaslimit {{.CUTTER_GAS_LIMIT}}' ) \
            --legacy \
            --diamond-owner-key ${ARENASTATE_OWNER_KEY} \
            --diamond-init-name DiamondNew \
            --diamond-init-args \
              '[{"typeURIs": ["GAME_TYPE", "TRANSCRIPT_TYPE", "FURNITURE_TYPE"]}]' \
            -f diamond-deploy.json \
            {{.CLI_ARGS}}

        if [ ! $(echo '{{.CLI_ARGS}}' | grep '\-\-\commit') ]; then
          echo "append '-- --commit' to your options to issue the transactions"
        fi

  deploy:new:
    dotenv: [".env.{{.PROVIDER_ID}}"]
    vars:
      PROVIDER_ID: '{{.PROVIDER_ID | default "hh"}}'
      GAS_PRICE: '{{.GAS_PRICE | default "0.001"}}'
      GAS_LIMIT: '{{.GAS_LIMIT | default ""}}'
      CUTTER_GAS_LIMIT: '{{.CUTTER_GAS_LIMIT | default ""}}'
      COMMIT: '{{.COMMIT | default ""}}'

    desc: |
      deploy the contracts

      This command is dry run by default, add '-- --commit' to deploy

    cmds:
      - |
        # source .env.{{.PROVIDER_ID}}
        echo "PROVIDER_ID {{.PROVIDER_ID}}"
        echo "PROVIDER_URL: $ARENASTATE_PROVIDER_URL"
        echo "ARENASTATE_DEPLOY_KEY: $ARENASTATE_DEPLOY_KEY"
        echo "ARENASTATE_ARENA: $ARENASTATE_ARENA"
        echo "ARENASTATE_OWNER_KEY: $ARENASTATE_OWNER_KEY"

        FACETS_DEPLOYED="{{.PROVIDER_ID}}.{{.FACETS_DEPLOYED}}"

        [ -z $FACETS_DEPLOYED ] && echo 'A filename for --facets-deployed is required' && exit 1
        if [ ! -f $FACETS_DEPLOYED ]; then
          echo '{}' > $FACETS_DEPLOYED
        else
          echo "**** re-using deployed facets from $FACETS_DEPLOYED ***"
        fi

        {{.DEPLOYCLI}} list \
          -I facet -n Diamond DiamondNew \
          -i node_modules/@polysensus/chaintrap-contracts/abi \
          --format json -x node_modules/@polysensus/chaintrap-contracts/abi/facets-exclude.json \
          > diamond-deploy.json

        {{.DEPLOYCLI}} \
          -u "${ARENASTATE_PROVIDER_URL}" \
          -d "${ARENASTATE_DEPLOY_KEY}" \
          diamond-new \
            --replace \
            $([ -n '{{.GAS_PRICE}}' ] && echo -n '--gasprice {{.GAS_PRICE}}' ) \
            $([ -n '{{.GAS_LIMIT}}' ] && echo -n '--gaslimit {{.GAS_LIMIT}}' ) \
            $([ -n '{{.CUTTER_GAS_LIMIT}}' ] && echo -n '--cutter-gaslimit {{.CUTTER_GAS_LIMIT}}' ) \
            --legacy \
            --diamond-owner-key ${ARENASTATE_OWNER_KEY} \
            --diamond-init-name DiamondNew \
            --diamond-init-args \
              '[{"typeURIs": ["GAME_TYPE", "TRANSCRIPT_TYPE", "FURNITURE_TYPE"]}]' \
            --facets diamond-deploy.json \
            --facets-deployed=$FACETS_DEPLOYED \
            --save-facets-deployed=$FACETS_DEPLOYED \
            {{.CLI_ARGS}}

        if [ ! $(echo '{{.CLI_ARGS}}' | grep '\-\-\commit') ]; then
          echo "append '-- --commit' to your options to issue the transactions"
        fi

  find:
    dotenv: [".env.{{.PROVIDER_ID}}"]
    vars:
      PROVIDER_ID: '{{.PROVIDER_ID | default "hh"}}'
      DIAMOND_NONCE: '{{.DIAMOND_NONCE | default ""}}'

    desc: find the arena on the chosen PROVIDER_ID
    cmds:
      - |
        {{.DEPLOYCLI}} \
          -u "${ARENASTATE_PROVIDER_URL}" \
          -d "${ARENASTATE_DEPLOY_KEY}" \
          find \
            $([ -n '{{.DIAMOND_NONCE}}' ] && echo -n '--diamond-nonce {{.DIAMOND_NONCE}}' )

  dev:hh:start:
    desc: start a local hardhat node (if there isn't one running)
    cmds:
      - tusk -q -f {{.TUSKS}}/tusk-hardhat.yml start-node -d .local/hh
      - rm -f hh.{{.FACETS_DEPLOYED}}

  dev:hh:restart:
    desc: restart the local hardhat node
    deps: [dev:hh:stop]
    cmds:
      - task: dev:hh:start

  dev:hh:stop:
    desc: stop a local hardhat node (according to pid in .local/hh/hh-pid)
    cmds:
      - |
        set -x
        ls -la {{.TUSKS}}
        tusk -q -f {{.TUSKS}}/tusk-hardhat.yml stop-node -d .local/hh

  resolve-key:
    desc: |
      resolve the key to use

      Intended for internal use to fall back to a task specific 'default' named key.

      task file user MAY set KEY

      calling task always sets KEY_ENV_DEFAULT

      If the user hasn't set KEY, then ARENASTATE_<KEY_ENV_DEFAULT>_KEY is used

    dotenv: [".env.{{.PROVIDER_ID}}"]
    vars:
      # taskfile user sets KEY if they want to override.
      KEY: '{{.KEY | default ""}}'
      # calling task sets this un-conditionaly to specify the key to default to
      KEY_ENV_DEFAULT: '{{.KEY_ENV_DEFAULT | default "GUARDIAN"}}'
    cmds:
      - |
        KEY={{.KEY}}
        KEY=${KEY:-$ARENASTATE_{{.KEY_ENV_DEFAULT}}_KEY}
        [ -z "$KEY" ] && echo "failed to resolve key" && exit 1
        echo $KEY

  resolve-arena:
    desc: |
      resolve the arena contract proxy address

      For the hardhat provider we find the latest deployed

      For all other providers we *require* that ARENASTATE_ARENA is set in the
      env and not empty.

    dotenv: [".env.{{.PROVIDER_ID}}"]
    vars:
      PROVIDER_ID: '{{.PROVIDER_ID | default "hh"}}'
    cmds:
      - |
        if [ "{{.PROVIDER_ID}}" = "hh" ]; then
          task -s find PROVIDER_ID={{.PROVIDER_ID}}
          exit 0
        elif [ -z "$ARENASTATE_ARENA" ]; then
          echo "The arena proxy address must be supplied explicitly unless using hardhat"
          exit 1
        fi
        echo $ARENASTATE_ARENA