npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@golem-sdk/react

v4.0.0

Published

React hooks for working with the Golem Network

Downloads

154

Readme

Golem React SDK

A collection of React hooks for interacting with the Golem Network.

Installation

Get started by installing the core package and it's peer dependencies:

npm install @golem-sdk/react @golem-sdk/task-executor@2 @golem-sdk/golem-js@3

Then make sure to wrap your app with the YagnaProvider component:

<YagnaProvider>
  <App />
</YagnaProvider>

Initial Configuration

For the SDK to work properly you need to have a running Yagna instance on your local machine. Please follow the Yagna installation guide to install and configure Yagna.

Yagna blocks all requests from external origins by default. To allow the SDK to communicate with it you need start Yagna with --api-allow-origin='<your-domain>' flag. For example:

yagna service run --api-allow-origin='http://localhost:3000'

Demo application

Sometimes it's easier to learn by example. That's why we've created a demo application that uses all the hooks from the SDK. You can find it in the examples/react-with-vite directory. To run it locally, first clone the repository, install it's dependencies and build the react package:

git clone https://github.com/golemfactory/golem-sdk-react.git
cd golem-sdk-react/
npm install
npm run build

Then run the following command to start the demo application:

npm run example:vite

If you just want to see how the demo application looks like, you can check out the live version here.

Features

useYagna - check if you're connected to Yagna and manage the app-key

function MyComponent() {
  const { isConnected, appKey, setYagnaOptions } = useYagna();
  const inputRef = useRef(null);
  return (
    <div>
      <div>Connected to Yagna: {isConnected ? "yes" : "no"}</div>
      <input ref={inputRef} />
      <button
        onClick={() => setYagnaOptions({ apiKey: inputRef.current.value })}
      >
        Set app key
      </button>
    </div>
  );
}

useExecutor + useTask - run a task on the Golem Network

function MyTask({ executor }) {
  const { isRunning, error, result, run } = useTask(executor);
  const onClick = () =>
    run(async (exe) => {
      return (await exe.run("echo", ["Hello world!"])).stdout;
    });
  return (
    <div>
      <button onClick={onClick} disabled={isRunning}>
        Run task
      </button>
      {isRunning && <div>Task is running...</div>}
      {error && <div>Task failed due to {error.toString()}</div>}
      {result && <div>Task result: {result}</div>}
    </div>
  );
}

function MyComponent() {
  const {
    executor,
    initialize,
    isInitialized,
    isInitializing,
    terminate,
    error,
  } = useExecutor({
    demand: {
      workload: { imageTag: "golem/alpine:latest" },
    },
    market: {
      rentHours: 0.5,
      pricing: {
        model: "linear",
        maxStartPrice: 0.5,
        maxCpuPerHourPrice: 1.0,
        maxEnvPerHourPrice: 0.5,
      },
    },
  });
  if (isInitializing) {
    return <div>Initializing executor...</div>;
  }
  if (error) {
    return <div>Error: {error.toString()}</div>;
  }
  if (!isInitialized) {
    return (
      <div>
        <button onClick={initialize}>Initialize executor</button>
      </div>
    );
  }
  return (
    <div>
      <MyTask executor={executor} />
      <button onClick={terminate}>Terminate executor</button>
    </div>
  );
}

useInvoices + useHandleInvoice - list and handle invoices

function Invoice({ invoiceId }) {
  const { acceptInvoice } = useHandleInvoice(invoiceId);

  return (
    <li key={invoice.invoiceId}>
      {invoice.invoiceId} - {invoice.status}
      <button onClick={acceptInvoice} disabled={invoice.status !== "RECEIVED"}>
        Accept
      </button>
    </li>
  );
}

function MyComponent() {
  const { invoices, isLoading, error, refetch } = useInvoices({
    limit: 10,
    statuses: ["RECEIVED"],
    after: new Date("2021-01-01"),
  });
  if (isLoading) {
    return <div>Loading...</div>;
  }
  if (error) {
    return <div>Error: {error.toString()}</div>;
  }
  return (
    <div>
      <ul>
        {invoices.map((invoice) => (
          <Invoice key={invoice.invoiceId} invoiceId={invoice.invoiceId} />
        ))}
      </ul>
      <button onClick={refetch}> Refresh </button>
    </div>
  );
}

Developing

If you want to contribute to the SDK, you can clone the repository and install the dependencies:

git clone https://github.com/golemfactory/golem-sdk-react.git
cd golem-sdk-react/
npm install

Links

  • Golem documentation: https://docs.golem.network/
  • Repository: https://github.com/golemfactory/golem-sdk-react/
  • Issue tracker: https://github.com/golemfactory/golem-sdk-react/issues
    • In case of sensitive bugs like security vulnerabilities, please contact [email protected] directly instead of using issue tracker. We value your effort to improve the security and privacy of this project!
  • Related projects:
    • Golem JavaScript API: https://github.com/golemfactory/golem-js/

Licensing

The code in this project is licensed under GPL-3.0 license.