@remix-project/remix-url-resolver

Remix Url Resolver


@remix-project/remix-url-resolver is a tool to handle import from different sources and resolve the content. It is used in Remix IDE to handle imports from GitHub, Swarm, IPFS and other URLs.

$3

@remix-project/remix-url-resolver is an NPM package and can be installed using NPM as:

yarn add @remix-project/remix-url-resolver

$3

@remix-project/remix-url-resolver exports:

``

export declare class RemixURLResolver {
private previouslyHandled;
gistAccessToken: string;
constructor(gistToken?: string);
/**
* Handle an import statement based on github
* @param root The root of the github import statement
* @param filePath path of the file in github
*/
handleGithubCall(root: string, filePath: string): Promise;
/**
* Handle an import statement based on http
* @param url The url of the import statement
* @param cleanUrl
*/
handleHttp(url: string, cleanUrl: string): Promise;
/**
* Handle an import statement based on https
* @param url The url of the import statement
* @param cleanUrl
*/
handleHttps(url: string, cleanUrl: string): Promise;
handleSwarm(url: string, cleanUrl: string): Promise;
/**
* Handle an import statement based on IPFS
* @param url The url of the IPFS import statement
*/
handleIPFS(url: string): Promise;
getHandlers(): Handler[];
resolve(filePath: string, customHandlers?: Handler[]): Promise;
}

`

Usage

resolve(url, customHandlers) function should be called from within handleImportCb function of solc.compile(input, handleImportCb).

`ts
import { RemixURLResolver } from 'remix-url-resolver'

const urlResolver = new RemixURLResolver()
const fileName: string = '../greeter.sol'
urlResolver.resolve(fileName, urlHandler)
.then((sources: object) => {
console.log(sources)
})
.catch((e: Error) => {
throw e
})
``

#### References

* TypeScript Publishing
* DefinitelyTyped 'Create a new package' guide

$3

Please feel free to open an issue or a pull request.

In case you want to add some code, do have a look at our contribution guidelines here. Reach us on Gitter in case of any queries.

$3

MIT © 2018-21 Remix Team