Orbs Network
  • Overview
    • What is Orbs?
    • Layer 3 Protocol
    • Running on EVM and TON
    • Enhanced Execution
    • L3 for Advanced Trading
    • Network Diagram
    • White Papers and Spec
  • Orbs Lambda
    • What is Orbs Lambda?
    • Network Diagram
    • Example Use Cases
    • Step by Step Overview
      • Development Requirements
      • Select Unique ID
      • Project Template
      • index.js Implementation
        • Execution Environment
        • Allowed Packages
        • Supported Networks
        • Execution Triggers
        • Sending Transactions
      • Testing Locally
      • Deploying to Production
      • Analyzing Execution
  • Orbs VM
    • What is Orbs VM?
    • Network Diagram
    • Example Use Cases
    • Step by Step Overview
      • Development Requirements
      • Select Unique ID
      • Docker Image Implementation
        • Execution Environment
        • Working Directory
        • Entry Point
        • Health Check
        • status.json
      • Testing Locally
      • Deploying to Production
      • Analyzing Execution
  • Powered by Orbs
    • Liquidity Hub
      • Integration Spec
    • Perpetual Hub
    • dTWAP Protocol
      • Integration Spec
      • Network Diagram
      • dTWAP Tutorial
      • FAQ
    • dLIMIT Protocol
      • Integration Spec
      • dLIMIT Tutorial
      • FAQ
  • Community Projects
    • Notification Protocol
      • Integrate a New Project
      • Network Diagram
    • TON Access
      • Network Diagram
    • TON Vote
Powered by GitBook
On this page
  • Directory structure
  • Setting up example
  1. Orbs Lambda
  2. Step by Step Overview

Project Template

PreviousSelect Unique IDNextindex.js Implementation

Last updated 4 months ago

Directory structure

Orbs Lambda enforces a strict directory structure for your project. It is recommended to create a of the official Orbs Lambda repo on GitHub:

  • The root of your project should contain a top-level directory with your

  • This directory should contain the file index.js - the main entry point of your lambda

  • This directory may contain any additional dependencies (.js and .json files)

  • This directory may contain a test suite under the test subdirectory

    • Test suite files should have the .spec.js suffix

    • The tests directory may contain any additional dependencies (.js and .json files)

  • Any package.json files should be found in the root

Setting up example

Assuming your local project working directory is my-lambda-project 

git clone https://github.com/orbs-network/orbs-lambda my-lambda-project

And assuming your unique ID is unique-example

This is the expected directory structure:

my-lambda-project/
├─ unique-example/
|  ├─ index.js
|  ├─ optional-dependency.js
|  ├─ optional-dependency.json
|  ├─ test/
|  |  ├─ my-tests.spec.js
|  |  ├─ more-tests.spec.js
|  |  ├─ optional-dependency.js
|  |  ├─ optional-dependency.json
├─ package.json
local fork
https://github.com/orbs-network/orbs-lambda
unique ID