2.3.2 • Published 10 months ago
automate-sdk v2.3.2
Gelato Automate SDK
Automate your smart contracts using Automate SDK
Installation
yarn add @gelatonetwork/automate-sdk
or
npm install @gelatonetwork/automate-sdk
How to use?
- Import the Automate SDK into your project:
import { AutomateSDK } from "@gelatonetwork/automate-sdk";
- Check if Automate is deployed on your network:
import { isAutomateSupported } from "@gelatonetwork/automate-sdk";
if (!isAutomateSupported(chainId)) {
console.log(`Automate network not supported (${chainId})`);
return;
}
- Instantiate Automate using your signer:
const automate = new AutomateSDK(chainId, signer);
- Create an automation task:
interface CreateTaskOptions {
name: string; // your task name
// Function to execute
execAddress: string; // address of your target smart contract
execSelector: string; // function selector to execute on your target smart contract
execAbi?: string; // ABI of your target smart contract
// Proxy caller
dedicatedMsgSender: boolean; // task will be called via a dedicated msg.sender which you can whitelist (recommended: true)
// Optional: Pre-defined / static target smart contract inputs
execData?: string; // exec call data
// Optional: Dynamic target smart contract inputs (using a resolver)
resolverAddress?: string; // resolver contract address
resolverData?: string; // resolver call data (encoded data with function selector)
resolverAbi?: string; // your resolver smart contract ABI
// Optional: Time based task params
interval?: number; // execution interval in seconds
startTime?: number; // start timestamp in seconds or 0 to start immediately (default: 0)
// Optional: Single execution task
singleExec?: boolean; // task cancels itself after 1 execution if true.
// Optional: Payment params
useTreasury?: boolean; // use false if your task is self-paying (default: true)
}
const params: CreateTaskOptions = { name, execAddress, execSelector, interval, dedicatedMsgSender };
const { taskId, tx }: TaskTransaction = await automate.createTask(params);
await tx.wait(); // Optionally wait for tx confirmation
console.log(`Task created, taskId: ${taskId} (tx hash: ${tx.hash})`);
- Retrieve all your tasks:
const activeTasks = await automate.getActiveTasks();
activeTasks.forEach((task: Task) => {
console.log(`- ${task.name} (${task.taskId})`);
});
- Rename a task:
await automate.renameTask(taskId, "Another Gelato name");
- Cancel a task:
const { taskId, tx }: TaskTransaction = await automate.cancelTask(taskId);
await tx.wait(); // Optionally wait for tx confirmation
console.log(`Task canceled, taskId: ${taskId} (tx hash: ${tx.hash})`);
- Overriding gas settings:
If you need to override gas settings, you can pass an additional Overrides
object to createTask
& cancelTask
methods:
const params: CreateTaskOptions = { name, execAddress, execSelector, interval, dedicatedMsgSender };
const overrides: Overrides = { gasLimit: 2000000 };
const tx: TaskTransaction = await automate.createTask(params, overrides);
- Whitelisting msg.sender of function:
If you enabled dedicatedMsgSender
, your task will be called via a dedicated msg.sender
which you can whitelist on your smart contract for extra security.
If dedicatedMsgSender
is set to false, msg.sender
of the task will be the Automate contract.
To fetch your dedicated msg.sender
:
const { address } = await automate.getDedicatedMsgSender();
console.log("Dedicated msg.sender: ", address);
Examples
Check out our tutorial repository automate-sdk-hello-world for more in-depth examples.