@golem-sdk/golem-js
Advanced tools
NodeJS and WebBrowser SDK for building apps running on Golem Network
golem-js?The Golem Network fosters a global group of creators building ambitious software solutions that will shape the technological landscape of future generations by accessing computing resources across the platform. Golem Network is an accessible, reliable, open access and censorship-resistant protocol, democratizing access to digital resources and connecting users through a flexible, open-source platform.
golem-js is the JavaScript API that allows developers to connect to their Golem nodes and manage their distributed, computational loads through Golem Network.
Visit our official documentation to learn more about the JavaScript SDK and how to use it.
To quickly get started with a new project using golem-js, you can use the following template:
npx @golem-sdk/cli@latest new my-awesome-golem-project
@golem-sdk/golem-js is available as a NPM package.
You can install it through npm:
npm install @golem-sdk/golem-js
or by yarn:
yarn add @golem-sdk/golem-js
The SDK is designed to work with LTS versions of Node (starting from 18) and with browsers.
Before you start using the SDK, you need to have yagna installed and running on your machine. Yagna is a service that
communicates and performs operations on the Golem Network, upon your requests via the SDK. You can follow the instructions below or visit the official documentation to set it up.
# Join the network as a requestor
curl -sSf https://join.golem.network/as-requestor | bash -
# Start the golem node on your machine,
# you can use `daemonize` to run this in background
yagna service run
Now that you have yagna running, you can initialize your requestor and request funds (tGLM tokens) on the test network.
# IN SEPARATE TERMINAL (if not daemonized)
# Initialize your requestor
yagna payment init --sender --network holesky
# Request funds on the test network
yagna payment fund --network holesky
# Check the status of the funds
yagna payment status --network holesky
app-key to use with SDKIf you don't have any app-keys available from yagna app-key list, go ahead and create one with the command below.
You will need this key in order to communicate with yagna from your application. You can set it
as YAGNA_APPKEY environment variable.
yagna app-key create my-golem-app
import { MarketOrderSpec, GolemNetwork } from "@golem-sdk/golem-js";
// Define the order that we're going to place on the market
const order: MarketOrderSpec = {
demand: {
workload: { imageTag: "golem/alpine:latest" },
},
market: {
// We're only going to rent the provider for 5 minutes max
rentHours: 5 / 60,
pricing: {
model: "linear",
maxStartPrice: 0.5,
maxCpuPerHourPrice: 1.0,
maxEnvPerHourPrice: 0.5,
},
},
};
(async () => {
const glm = new GolemNetwork();
try {
await glm.connect();
// Lease a machine
const lease = await glm.oneOf(order);
await lease
.getExeUnit()
.then((exe) => exe.run("echo Hello, Golem! 👋"))
.then((res) => console.log(res.stdout));
await lease.finalize();
} catch (err) {
console.error("Failed to run the example", err);
} finally {
await glm.disconnect();
}
})().catch(console.error);
import { GolemNetwork, MarketOrderSpec } from "@golem-sdk/golem-js";
// Define the order that we're going to place on the market
const order: MarketOrderSpec = {
demand: {
workload: { imageTag: "golem/alpine:latest" },
},
market: {
rentHours: 0.5,
pricing: {
model: "linear",
maxStartPrice: 0.5,
maxCpuPerHourPrice: 1.0,
maxEnvPerHourPrice: 0.5,
},
},
};
(async () => {
const glm = new GolemNetwork();
try {
await glm.connect();
// create a pool that can grow up to 3 leases at the same time
const pool = await glm.manyOf({
concurrency: 3,
order,
});
// run 3 tasks in parallel on 3 different machines
await Promise.allSettled([
pool.withLease(async (lease) =>
lease
.getExeUnit()
.then((exe) => exe.run("echo Hello, Golem from the first machine! 👋"))
.then((res) => console.log(res.stdout)),
),
pool.withLease(async (lease) =>
lease
.getExeUnit()
.then((exe) => exe.run("echo Hello, Golem from the second machine! 👋"))
.then((res) => console.log(res.stdout)),
),
pool.withLease(async (lease) =>
lease
.getExeUnit()
.then((exe) => exe.run("echo Hello, Golem from the third machine! 👋"))
.then((res) => console.log(res.stdout)),
),
]);
} catch (err) {
console.error("Failed to run the example", err);
} finally {
await glm.disconnect();
}
})().catch(console.error);
Instead of waiting for the command to finish, you can stream the results as they come in. This is useful for long-running commands, where you want to see the output as it's being produced.
const remoteProcess = await exe.runAndStream(
`
sleep 1
echo -n 'Hello from stdout' >&1
sleep 1
echo -n 'Hello from stdout again' >&1
sleep 1
echo -n 'Hello from stdout yet again' >&1
`,
);
remoteProcess.stdout.on("data", (data) => console.log("stdout>", data));
await remoteProcess.waitForExit();
You can transfer files to and from the remote machine. This is useful when you need to provide input files or retrieve the results of the computation.
await exe
.beginBatch()
.run(`echo "Message from provider ${exe.provider.name}. Hello 😻" >> /golem/work/message.txt`)
.downloadFile("/golem/work/message.txt", "./message.txt")
.end();
console.log(await readFile("./results.txt", { encoding: "utf-8" }));
You can connect yourself and multiple providers to a VPN network. This is useful when you want to communicate securely between the nodes.
const network = await glm.createNetwork({ ip: "192.168.7.0/24" });
// ...
const exe1 = await lease1.getExeUnit();
const exe2 = await lease2.getExeUnit();
await exe1
.run(`ping ${exe2.getIp()} -c 4`)
.then((res) => console.log(`Response from provider: ${exe1.provider.name} (ip: ${exe1.getIp()})`, res.stdout));
You can listen to various events that are emitted by the SDK. This is useful when you want to react to certain conditions, like calculating the total cost of all invoices received.
glm.payment.events.on("invoiceAccepted", (invoice) => {
console.log("Invoice '%s' accepted for %s GLM", invoice.id, invoice.amount);
});
You can define custom filters to select the providers that you want to work with. This is useful when you want to blacklist or whitelist certain providers.
const myFilter: ProposalFilter = (proposal) => proposal.provider.name !== "bad-provider";
const order: MarketOrderSpec = {
market: {
proposalFilter: myFilter,
// other options
},
};
We have also prepared a set of predefined filters for common use-cases. Check out the example with predefined filters here
You can define a method that will select which proposal should be chosen first. This is useful when you want to prioritize certain providers over others.
const scores = {
"very-good-provider": 10,
"good-provider": 5,
"bad-provider": -10,
};
const bestProviderSelector = (proposals: OfferProposal[]) => {
return proposals.sort((a, b) => (scores[b.provider.name] || 0) - (scores[a.provider.name] || 0))[0];
};
const order: MarketOrderSpec = {
market: {
proposalSelector: bestProviderSelector,
// other options
},
};
You can avoid using the registry and upload a GVMI image directly to the provider. This is useful when you want to quickly prototype your image without having to update the registry with every change.
const order: MarketOrderSpec = {
demand: {
workload: {
imageUrl: "file:///path/to/your/image.gvmi",
},
// other options
},
};
If you wish to learn more about how the SDK functions under the hood, please check out our more advanced examples:
The examples directory in the repository contains various usage patterns for the SDK. You can browse through them and learn about the recommended practices. All examples are automatically tested during our release process.
In case you find an issue with the examples, feel free to submit an issue report to the repository.
You can find even more examples and tutorials in the JavaScript API section of the Golem Network Docs.
The SDK uses the debug package to provide debug logs. To enable them, set the DEBUG environment variable to golem-js:* or golem-js:market:* to see all logs or only the market-related ones, respectively. For more information, please refer to the debug package documentation.
Read the dedicated testing documentation to learn more about how to run tests of the SDK.
It is recommended to run unit tests and static code analysis before committing changes.
yarn lint
# and
yarn format
FAQs
NodeJS and WebBrowser SDK for building apps running on Golem Network
The npm package @golem-sdk/golem-js receives a total of 9 weekly downloads. As such, @golem-sdk/golem-js popularity was classified as not popular.
We found that @golem-sdk/golem-js demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Newly introduced telemetry in devenv 1.4 sparked a backlash over privacy concerns, leading to the removal of its AI-powered feature after strong community pushback.
Security News
TC39 met in Seattle and advanced 9 JavaScript proposals, including three to Stage 4, introducing new features and enhancements for a future ECMAScript release.
Security News
Deno 2.2 enhances Node.js compatibility, improves dependency management, adds OpenTelemetry support, and expands linting and task automation for developers.