Vault

The vault Aptitude is not intended for storing large amounts of data.
API
Example
Permissions
remove
Removes the entry from the vault with the specified key.
1
import { vault } from '@oliveai/ldk';
2
​
3
const key = 'myKey';
4
​
5
vault.remove(key).then(() => {
6
    console.log(`Removed ${key} from the vault`);
7
});
Copied!
exists
Returns true if an entry with the specified key is in the vault.
1
import { vault } from '@oliveai/ldk';
2
​
3
const key = 'myKey';
4
​
5
vault.exists(key).then((inVault) => {
6
    console.log(`${key} ${!inVault ? 'does not exist' : 'exists'} in the vault.`);
7
});
Copied!
read
Returns the value stored in the vault with the specified key.
1
import { vault } from '@oliveai/ldk';
2
​
3
const key = 'myKey';
4
​
5
vault.read(key).then((value) => {
6
    console.log(`${key} maps to ${value}`);
7
});
8
​
Copied!
write
Adds the given value to the vault with the specified key.
1
import { vault } from '@oliveai/ldk';
2
​
3
const key = 'myKey';
4
const value = 'some value to write';
5
​
6
vault.write(key, value).then(() => {
7
    console.log(`Wrote ${value} to ${key}`);
8
});
Copied!
Let's suppose we have a Loop that needs to access network resources that are locked behind a security token. We'll create a Loop that retrieves and stores this token to be used elsewhere within the Loop.
1
import { network, user, vault } from '@oliveai/ldk';
2
​
3
const tokenKey = 'myloop_token';
4
const expirationKey = 'myloop_expiration';
5
const oneDayMs = 24 * 60 * 60 * 1000;
6
​
7
const tokenUrl = 'http://127.0.0.1:8080/token';
8
const apiUrl = 'http://127.0.0.1:8080/myTestApi';
9
​
10
async function refreshToken() {
11
    // We'll use the jwt provided by the user aptitude to act as our authorization
12
    // to hit the token endpoint
13
    const jwt = await user.jwt();
14
    const response = await network.httpRequest({
15
        url: tokenUrl,
16
        method: 'GET',
17
        headers: {
18
            Authorization: `Bearer ${jwt}`,
19
        },
20
    });
21
​
22
    if (response.statusCode != 200) {
23
        return;
24
    }
25
​
26
    const token = await network.decode(response.body);
27
    const expirationTime = Date.now() + oneDayMs;
28
  
29
    // Once we've retrieved the new token, we can store it securely in the vault
30
    await vault.write(tokenKey, token);
31
    await vault.write(expirationKey, expirationTime);
32
}
33
​
34
// This will be the main entrypoint into our example
35
async function main() {
36
    let exists = await vault.exists(expirationKey);
37
  
38
    if (exists) {
39
        // If the key exists in vault, we need to make sure it hasn't expired
40
        let expirationTimeStr = await vault.read(expirationKey);
41
        let expirationTime = parseInt(expirationTimeStr);
42
        if (expirationTime < Date.now()) {
43
            await refreshToken();
44
        }
45
    } else {
46
        await refreshToken();
47
    }
48
​
49
    // Check to make sure the user token exists before retrieving it
50
    // Something could have gone wrong with refreshToken();
51
    const userTokenExists = await vault.exists(tokenKey);
52
    if (!userTokenExists) {
53
        return;
54
    }
55
​
56
    // Read the key and make an API request to get our data
57
    const userToken = await vault.read(tokenKey);
58
    const someData = await network.httpRequest({
59
        url: apiUrl,
60
        method: 'GET',
61
        headers: {
62
            Authorization: `Bearer ${userToken}`,
63
        },
64
    });
65
​
66
    // Do something with someData
67
}
68
​
69
main();
Copied!
To use the Vault Aptitude, simply set the following permissions in your package.json under the ldk object.
​
Please see our Permissions page for more information.
​
1
...
2
"ldk": {
3
  "permissions": {
4
    "vault": {},
5
    ...
6
  }
7
},
8
...
Copied!

JWT

Next - APTITUDES

Whisper

Last modified 3mo ago

Copy link