Nupital Pomp Mesmerises

    defender-autotask-client
    TypeScript icon, indicating that this package has built-in type declarations

    1.37.0 • Public • Published

    Defender Autotask Client

    The Defender Autotasks service allows you to run small code snippets on a regular basis or via webhooks that can make calls to the Ethereum network or to external APIs. Thanks to tight integration to Defender Relayers, you can use Autotasks to automate regular actions on your contracts.

    This client allows you to update the code of your Autotasks programmatically, so you don't need to copy-paste code into the Defender web application. Additionally, the client allows you to easily create, list, retrieve, delete and update your Autotasks.

    Example usage:

    $ defender-autotask update-code 19ef0257-bba4-4723-a18f-67d96726213e ./lib/my-autotask

    Install

    npm install defender-autotask-client
    yarn add defender-autotask-client

    Usage

    The client can be used either programmatically as part of a script, or directly via the command line. Both uses require a Defender Team API Key. Create one on the top-right menu in the Defender web application, and grant to it the capability to manage autotask code.

    Keep in mind that your Autotask code should include an index.js javascript file with an entrypoint, such as the following. You may also require other files you include in the bundle.

    exports.handler = async function () {
      /* your code here */
    };

    Note that you can only use the client to update the code of an existing Autotask.

    Command line

    Set the environment variables API_KEY and API_SECRET to the Team API key/secret you created on Defender, and invoke the defender-autotask bin:

    $ defender-autotask update-code $AUTOTASK_ID $PATH_TO_CODE
    $ defender-autotask execute-run $AUTOTASK_ID
    $ defender-autotask tail-runs $AUTOTASK_ID

    Beware that the defender-autotask CLI will automatically load environment variables from a local .env file if found.

    Note: In order to get the CLI to work, it should've been installed globally, otherwise, you can prefix with npx if you're using it directly on bash. This is not necessary when running from your package.json defined scripts.

    Script usage

    Use the Team API key to initialize an instance of the Defender Autotask client:

    const { AutotaskClient } = require('defender-autotask-client');
    const client = new AutotaskClient({ apiKey: API_KEY, apiSecret: API_SECRET });

    List

    To list your current autotasks, simply call the list function.

    await client.list();

    Create

    To create a new autotask, construct an CreateAutotaskRequest object.

    interface CreateAutotaskRequest {
      name: string;
      encodedZippedCode: string;
      relayerId?: string;
      trigger: {
        type: 'schedule' | 'webhook',
        frequencyMinutes?: number,
        cron?: string,
      };
      paused: boolean;
    }

    And pass down the object to the create function.

    const myAutotask: CreateAutotaskRequest = { name: "myAutotask", paused: false, ... };
    await client.create(myAutotask);

    Retrieve

    To retrieve one of your autotask, call the get function with the autotask Id.

    await client.get('671d1f80-99e3-4829-aa15-f01e3298e428');

    Update

    To update an existing autotask, construct an UpdateAutotaskRequest object.

    interface UpdateAutotaskRequest {
      autotaskId: string;
      name: string;
      encodedZippedCode?: string;
      relayerId?: string;
      trigger: {
        type: 'schedule' | 'webhook',
        frequencyMinutes?: number,
        cron?: string,
      };
      paused: boolean;
    }

    And pass down the object to the update function.

    const myAutotask: UpdateAutotaskRequest = { name: "myAutotask-V2", paused: true, ... };
    await client.update(myAutotask);

    Delete

    To delete one of your autotask, call the delete function with the autotask Id.

    await client.delete('671d1f80-99e3-4829-aa15-f01e3298e428');

    Update Code

    To update the code of an existing Autotask, zip it and upload it using the client, providing the ID of the Autotask to update:

    const zip = fs.readFileSync('code.zip');
    await client.updateCodeFromZip(autotaskId, zip);

    Alternatively, you can also choose a folder to upload, and the client will take care of zipping it and uploading it:

    await client.updateCodeFromFolder(autotaskId, './path/to/code');

    You can also provide the set of files and their content, and the client will generate and upload the zip file for you:

    await client.updateCodeFromSources(autotaskId, {
      'index.js': 'exports.handler = function() { return 42; }',
    });

    Autotask Runs

    To execute an autotask run, execute the command below substituting the autotaskId:

    await client.runAutotask(autotaskId);

    You can list all runs for an autotask with the following command:

    await client.listAutotaskRuns(autotaskId);

    And get detailed logs for a single run using the autotaskRunId (returned in the listAutotaskRuns response directly above):

    await client.getAutotaskRun(autotaskRunId);

    FAQ

    How do I find the ID of my Autotask?

    You can retrieve it from the Edit Code page of your Autotask, or directly from the URL. For instance, in the following URL, the ID is 19ef0257-bba4-4723-a18f-67d96726213e.

    https://defender.openzeppelin.com/#/autotask/19ef0257-bba4-4723-a18f-67d96726213e
    

    Can I use this package in a browser?

    This package is not designed to be used in a browser environment. Using this package requires sensitive API KEYS that should not be exposed publicly.

    Keywords

    none

    Install

    npm i defender-autotask-client

    DownloadsWeekly Downloads

    4,083

    Version

    1.37.0

    License

    MIT

    Unpacked Size

    124 kB

    Total Files

    28

    Last publish

    Collaborators

    • zeljkox
    • frangio
    • ernestognw
    • bjmrq
    • mok0230
    • tirumerla
    • dylkil
    • namis