As always, if you need any help, message us on Discord!
You'll need the following installed before building your plugin:
You'll be using TypeScript to implement your Polywrap plugin.
In the future, TypeScript will be one of many supported languages for implementing plugins. As more Polywrap Clients are released in various languages, implementing plugins in those languages will be supported as well.
To get started, use the following command to spin up a project folder for your plugin.
<project-name> is replaced with a custom name of your choosing. For example
Once complete, you'll see a new folder appear, named after the custom name you've chosen. Please navigate into this new directory (using
cd for example).
Let's ensure all of your project's dependencies are installed. From inside your project's directory, simply run:
nvm install && nvm use
Your project should look something like this:
This file defines the schema of your Polywrap plugin. This is the interface outside wrappers & users will use to query your plugin's functionality.
src/resolvers.ts file implements all query methods declared on the
Query query types in the
The resolvers also receive an instance of your custom Plugin class, enabling them to access its methods and contextual information. For example, in the case of the Ethereum plugin, it gives access to the Web3 provider object.
src/index.ts file contains the Plugin class, which will be created each time the plugin is instantiated. Use this class to store all contextual configuration data needed for your plugin (providers, settings, etc). Additionally you can add helper methods for the resolvers to use.
This file takes the place of the
web3api.yaml manifest file. It contains the plugin's schema, all Polywraps interfaces the plugin implements, and external Polywraps the plugin is dependent on.
Polywrap interfaces (schemas with no implementation) haven't been fully developed yet. Please stay tuned!
To build your plugin, all you need is the following command: