Skip to content

Latest commit

 

History

History
178 lines (128 loc) · 6.74 KB

README.md

File metadata and controls

178 lines (128 loc) · 6.74 KB
Raw

WASM-IPFS-Serverless: Decentralized Computing Made Simple

build test

WASM-IPFS-Serverless is an innovative framework that seamlessly integrates WebAssembly computing with IPFS storage and retrieval, offering a robust serverless solution for decentralized applications (dApps). Empowering developers with cutting-edge technologies, this project revolutionizes how decentralized computing is implemented and utilized.

image

wasm-ipfs-serverless.runtime.webm

Key Features and Components

  • WebAssembly Computing: Harness the power of WebAssembly for efficient and scalable computation within decentralized applications.
  • IPFS Integration: Utilize IPFS for secure and decentralized storage and retrieval of data, ensuring data integrity and availability.
  • Serverless Architecture: Embrace a serverless paradigm for flexible and cost-effective deployment of dApps, without the complexities of managing traditional servers.
  • Technical Support: Benefit from seamless integration with Filecoin-Lassie for IPFS file retrieval, Filecoin-IPLD-Go-Car for IPFS Car file extraction, Extism for wasm plug-in mechanism, wazero for wasm virtual machine, and Fiber for high-performance HTTP server capabilities.

How it's Made

Here's a breakdown of how WASM-IPFS-Serverless was built, including the technologies used, their integration, and any notable aspects:

WebAssembly (WASM) Computing

  • Technology: Leveraged WebAssembly for its efficient and portable bytecode format, enabling high-performance computing within the serverless environment.
  • Integration: Integrated WebAssembly runtime libraries and tools to compile and execute WASM modules seamlessly within the serverless framework.

IPFS Integration

  • Technology: Utilized IPFS (InterPlanetary File System) for decentralized storage and retrieval of data.
  • Integration: Integrated IPFS libraries and APIs to interact with the IPFS network, allowing for secure and decentralized data storage and retrieval.

Partner Technologies and Benefits

  • Filecoin-Lassie: Leveraged for IPFS file retrieval, enhancing data access capabilities within the serverless environment.
  • Filecoin-IPLD-Go-Car: Used for IPFS Car file extraction, enabling efficient handling of IPFS Car files within the project.
  • Extism: Integrated for wasm plug-in mechanism, facilitating extensibility and customization of the serverless environment through wasm plugins.
  • wazero: Utilized for wasm virtual machine capabilities, ensuring efficient execution of WebAssembly code within the serverless framework.
  • Fiber: Integrated for high-performance HTTP server functionalities, enhancing network communication and HTTP request handling within the serverless environment.

Notable Aspects

  • Dynamic IPFS Integration: Dynamically integrated with IPFS using Filecoin-Lassie and IPFS CID references in the configuration, allowing for seamless interaction with IPFS resources.

Overall, WASM-IPFS-Serverless aims to improve the convenience of decentralized and edge trusted computing, and aims to provide a powerful and efficient runtime framework for decentralized applications.

Quick Start

1. Clone the Repository

git clone https://github.com/BlockCraftsman/WASM-IPFS-Serverless.git

2. Build the Project

cd WASM-IPFS-Serverless
make

3. Adjust Configuration File

app-type: "WASM-IPFS-Serverless-WORKER"

# The network model of HTTP handle ,NetPoll(gin) RAWEPOLL(fiber)
net-model: "NETPOLL"

# Process inflow traffic network configuration
NetWork:
  bind-network: "TCP" #Network transport layer type: TCP | UDP 
  protocol-type: "HTTP" #Application layer network protocol：HTTP | RESP | QUIC
  bind-address: "127.0.0.1:28080" #Network listening address

#Runtime debug option
debug:
  enable: false
  pprof-bind-addr: "127.0.0.1:19090"

wasm-modules-files:
  enable: false
  path:
    - "hello.wasm"

wasm-modules-ipfs:
  enable: true
  lassie-net:
    scheme: "http"
    host: "38.45.67.159" #Filecoin Lassie daemon bind IP, This is a temporarily available address. When it is unavailable, please visit to install and run daemon. (https://github.com/filecoin-project/lassie?tab=readme-ov-file#http-api)
    port: 62156 #Filecoin Lassie daemon bind Port
  cids:
    - "QmeDsaLTc8dAfPrQ5duC4j5KqPdGbcinEo5htDqSgU8u8Z" #wasm IPFS CID

4. Load Configuration and Run

WASM-IPFS-Serverless -c wis_worker.yaml

5. Testing the IPFS Version of WASM Serverless

$ curl -d "WASM-IPFS-ServerLess" "http://localhost:28080"

👋 Hello WASM-IPFS-ServerLess%

Performance Testing

$ hey -n 1000000 -c 50 -m POST \ 
-d 'wasm-ipfs-serverless' \
"http://127.0.0.1:28080"

Summary:
  Total:        25.5373 secs
  Slowest:      0.0360 secs
  Fastest:      0.0001 secs
  Average:      0.0013 secs
  Requests/sec: 39158.4411
  
  Total data:   31000000 bytes
  Size/request: 31 bytes

Response time histogram:
  0.000 [1]     |
  0.004 [995857]        |■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■
  0.007 [3829]  |
  0.011 [205]   |
  0.014 [22]    |
  0.018 [14]    |
  0.022 [18]    |
  0.025 [4]     |
  0.029 [0]     |
  0.032 [0]     |
  0.036 [50]    |

Latency distribution:
  10% in 0.0002 secs
  25% in 0.0004 secs
  50% in 0.0014 secs
  75% in 0.0017 secs
  90% in 0.0021 secs
  95% in 0.0024 secs
  99% in 0.0031 secs

Details (average, fastest, slowest):
  DNS+dialup:   0.0000 secs, 0.0001 secs, 0.0360 secs
  DNS-lookup:   0.0000 secs, 0.0000 secs, 0.0000 secs
  req write:    0.0000 secs, 0.0000 secs, 0.0135 secs
  resp wait:    0.0012 secs, 0.0000 secs, 0.0349 secs
  resp read:    0.0000 secs, 0.0000 secs, 0.0049 secs

Status code distribution:
  [200] 1000000 responses

Contributing

We welcome contributions from the community. To contribute to this project:

  1. Fork the repository.
  2. Create a new branch (git checkout -b feature/your-feature).
  3. Make your changes and commit them (git commit -am 'Add new feature').
  4. Push your changes to the branch (git push origin feature/your-feature).
  5. Create a new Pull Request.

License

This library is dual-licensed under Apache 2.0 and MIT terms.

❤️ Thanks for Technical Support ❤️

  1. Filecoin-Lassie: Support IPFS file retrieval
  2. Filecoin-IPLD-Go-Car: Support IPFS Car file extraction