UMAprotocol / UMAprotocol/uma-docs

Error in OO Quick Start

Open
#11 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
No language data
Stars
6
Forks
17
PR merge metrics
No merged PRs in 30d

Description

While doing the Quickstart located at https://docs.umaproject.org/developers/optimistic-oracle/getting-started and going to the example contract in Remix located at https://remix.ethereum.org/#version=soljson-v0.8.16+commit.07a7930e.js&optimize=false&runs=200&gist=fba5d2812d940759f4f7585741b529a4 I cannot compile the contract as I get this error

Error: not found https://github.com/UMAprotocol/protocol/blob/master/packages/core/contracts/oracle/interfaces/OptimisticOracleV2Interface.sol

And when I checked, there is not interfaces folder in https://github.com/UMAprotocol/protocol/blob/master/packages/core/contracts/oracle/ and now it's been moved to https://github.com/UMAprotocol/protocol/blob/master/packages/core/contracts/optimistic-oracle/interfaces/OptimisticOracleV2Interface.sol

When I modify the Remix contract with the new URL it just works

// SPDX-License-Identifier: AGPL-3.0-only
pragma solidity ^0.8.14;

import "https://github.com/UMAprotocol/protocol/blob/master/packages/core/contracts/optimistic-oracle/interfaces/OptimisticOracleV2Interface.sol";

// *************************************

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Open the Optimistic Oracle Quickstart at docs.umaproject.org/developers/optimistic-oracle/getting-started and inspect the linked Remix example. Locate the import of OptimisticOracleV2Interface.sol, compare it with the current repository path under packages/core/contracts/optimistic-oracle/interfaces/, and update the documentation reference. Done means the example uses the current URL and compiles in Remix.

Written by the indexing model from the issue text.

Assessment

Tech stack
solidity
Domain
blockchain, documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.