@fluencelabs/aqua-lib

Search…

🌊

Aqua Book

Introduction

Getting Started

Language

Libraries

@fluencelabs/aqua-lib

@fluencelabs/aqua-ipfs

@fluencelabs/registry

Aqua CLI

Changelog

@fluencelabs/aqua-lib

API of protocol-level service (a.k.a builtins)

Releases
You can find the latest releases of aqua-lib on NPM and changelogs are on GitHub​
API
The most up-to-date documentation of the API is in the code, please check it out on GitHub​
Services
aqua-lib defines a number of services available on peers in the Fluence Network:
Op - short for "Operations". Functions for data transformation.
Peer - functions affecting peer's internal state
Kademlia - functions to manipulate libp2p Kademlia
Srv - short for "Service". Functions for service manipulation
Dist - short for "Distribution". Functions for module and blueprint distribution
Script - functions to run and remove scheduled (recurring) scripts
How to use it
In Aqua
Add @fluencelabs/aqua-lib to your dependencies as described in Libraries doc, and then import it in your Aqua script:
1
import "@fluencelabs/aqua-lib"
2
​
3
-- gather Peer.identify from all nodes in the neighbourhood
4
func getPeersInfo() -> []Info:
5
    infos: *Info
6
    nodes <- Kademlia.neighborhood(%init_peer_id%, nil, nil)
7
    for node in nodes:
8
        on node:
9
            infos <- Peer.identify()
10
    <- infos
Copied!
In TypeScript
aqua-lib is meant to be used to write Aqua scripts, and sinceaqua-lib doesn't export any top-level functions, it's not callable directly in the TypeScript. 
Patterns
Functions With A Variable Number Of Arguments
Currently, Aqua doesn't allow to define functions with a variable number of arguments. And  that limits aqua-lib API. But there's a way around that.
Let's take Op.concat_strings as an example. You can use it to concatenate several strings. aqua-lib provides the following signature:
1
concat_strings(a: string, b: string) -> string
Copied!
Sometimes that is enough, but sometimes you need to concatenate more than 2 strings at a time. Happily, under the hood concat_strings accepts any number of arguments, so you can redeclare it with the number of arguments that you want:
1
service MyOp("op"):
2
  concat_strings(a: string, b: string, c: string, d: string) -> string
Copied!
List of operations with a variable number of arguments
Here's a full list of other Op-s that you can apply this pattern to
Op.concat - can concatenate any number of arrays
Op.array - wraps any number of arguments into an array
Op.concat_string - concatenates any number of strings

Libraries

@fluencelabs/aqua-ipfs

Last modified 9mo ago

Copy link

Contents

Functions With A Variable Number Of Arguments