Skip to content

Commit 6df449f

Browse files
committed
Merge internal changes
1. migrate to mainnet 2. update dependency
1 parent 792f1cd commit 6df449f

11 files changed

+137
-119
lines changed

LICENSE

+13-3
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,15 @@
1-
Copyright 2018 Robin Lamberti
1+
The ISC License
22

3-
Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.
3+
Copyright (c) 2018 Robin Lamberti
44

5-
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
5+
Permission to use, copy, modify, and/or distribute this software for any
6+
purpose with or without fee is hereby granted, provided that the above
7+
copyright notice and this permission notice appear in all copies.
8+
9+
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10+
WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11+
MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12+
ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13+
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14+
ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15+
OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

README.md

+1-7
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
[![npm](https://img.shields.io/npm/v/raam.client.js.svg)](https://www.npmjs.com/package/raam.client.js)
2-
31
# RAAM - Random Access Authenticated Messaging
42
RAAM is a second layer data communication protocol for IOTA
53
enableing protected datastream access and publishing, organized in so called channels.
@@ -40,7 +38,7 @@ writing from/to RAAM channels.
4038
```js
4139
const RAAM = require('raam.client.js')
4240
const iota = require('@iota/core').composeAPI({
43-
provider: 'https://nodes.devnet.iota.org'
41+
provider: 'https://node.deviceproof.org'
4442
})
4543
const seed = "DONTGIVEYOURSEEDTOANYBODYELSEDONTGIVEYOURSEEDTOANYBODYELSEDONTGIVEYOURSEEDTOANYBODYELSE"
4644
const raam = await RAAM.fromSeed(seed, {height: 4, iota})
@@ -80,7 +78,3 @@ to ensure that two different messages in the same channel belong to the same aut
8078

8179
Because of that the maximum amount of messages that can be published in a channel depends on the size of a merkle tree,
8280
which has to be created in advance.
83-
84-
* * *
85-
86-
&copy; 2018 Robin Lamberti \<[email protected]\>.

docs/api.hbs

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# API Reference
2+
{{>main~}}
3+
4+
* * *
5+
6+
Documented by [jsdoc-to-markdown](https://github.com/jsdoc2md/jsdoc-to-markdown).

docs/api.md

+101-39
Large diffs are not rendered by default.

examples/channelSubscribe.js

-47
This file was deleted.

examples/constructAndPublishLater.js

+2-2
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ const prettify = require('../lib/helpers').prettify
33
const RAAMReader = require('../lib/raamReader')
44
const converter = require("@iota/converter")
55
const iota = require('@iota/core').composeAPI({
6-
provider: 'https://nodes.devnet.iota.org'
6+
provider: 'https://node.deviceproof.org'
77
});
88

99
(async () => {
@@ -59,4 +59,4 @@ function generateSeed(length = 81) {
5959
}
6060
let result = retVal.join("")
6161
return result;
62-
}
62+
}

examples/manualMessageConstruction.js

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
1-
const converter = require("@iota/converter") //require("iota.lib.js/lib/crypto/converter/converter")
1+
const converter = require("@iota/converter")
22
const merkle = require('../lib/merkle')
33
const sign = require('../lib/sign')
44
const sender = require('../lib/message')
55
const file = require('../lib/file')
66
const {intToTrytes, padTritsMultipleOf, digest} = require('../lib/helpers')
77
const fs = require('fs')
88
const iota = require('@iota/core').composeAPI({
9-
provider: 'https://nodes.devnet.iota.org'
9+
provider: 'https://node.deviceproof.org'
1010
});
1111

1212
(async () => {
@@ -137,4 +137,4 @@ function generateSeed(length = 81) {
137137
}
138138
let result = retVal.join("")
139139
return result;
140-
}
140+
}

examples/simpleReadWrite.js

+2-2
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ const RAAM = require('../lib/raam')
22
const converter = require("@iota/converter")
33
const RAAMReader = require('../lib/raamReader')
44
const iota = require('@iota/core').composeAPI({
5-
provider: 'https://nodes.devnet.iota.org'
5+
provider: 'https://node.deviceproof.org'
66
});
77

88
(async () => {
@@ -68,4 +68,4 @@ function generateSeed(length = 81) {
6868
}
6969
let result = retVal.join("")
7070
return result;
71-
}
71+
}

jsdoc2md/api.hbs

-6
This file was deleted.

lib/sign.js

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
const Kerl = require('@iota/kerl').default //require('iota.lib.js/lib/crypto/kerl/kerl')
2-
const converter = require('@iota/converter') //require("iota.lib.js/lib/crypto/converter/converter")
3-
const signing = require("@iota/signing") //require('iota.lib.js/lib/crypto/signing/signing')
1+
const Kerl = require('@iota/kerl').default
2+
const converter = require('@iota/converter')
3+
const signing = require("@iota/signing")
44
const {padTritsMultipleOf} = require("./helpers")
55

66
const PK_FRAGMENTS = 27
@@ -135,4 +135,4 @@ module.exports = {
135135
createKeyPair,
136136
createSignature,
137137
verifyMessage
138-
}
138+
}

package.json

+5-6
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "raam.client.js",
33
"version": "0.8.0",
4-
"description": "A messaging protocol for the IOTA tangle allowing access of arbitrary messages in O(1)",
4+
"description": "IOTA-based messaging protocol, allowing access of arbitrary messages in O(1)",
55
"keywords": [
66
"iota",
77
"dlt",
@@ -16,17 +16,16 @@
1616
],
1717
"repository": {
1818
"type": "git",
19-
"url": "https://github.com/cr0ssing/raam.client.js"
19+
"url": "https://github.com/DLTcollab/raam.client.js"
2020
},
2121
"author": {
22-
"name": "Robin Lamberti",
23-
"email": "[email protected]"
22+
"name": "Robin Lamberti"
2423
},
2524
"license": "ISC",
2625
"main": "lib/raam.js",
2726
"types": "types/index.d.ts",
2827
"scripts": {
29-
"docs": "jsdoc2md -t jsdoc2md/api.hbs lib/raam.js lib/raamReader.js > docs/api.md"
28+
"docs": "jsdoc2md -t docs/api.hbs lib/raam.js lib/raamReader.js > docs/api.md"
3029
},
3130
"dependencies": {
3231
"@iota/core": "1.0.0-beta.11",
@@ -45,7 +44,7 @@
4544
"zeromq": "^5.1.0"
4645
},
4746
"devDependencies": {
48-
"jsdoc-to-markdown": "^4.0.1",
47+
"jsdoc-to-markdown": "^5.0.0",
4948
"marked": "^0.6.2",
5049
"mocha": "^5.2.0"
5150
}

0 commit comments

Comments
 (0)