Noble migration + fixed contract addresses

.env.sample

@@ -0,0 +1,2 @@
+NETWORK_PRIVATE_KEY=somehexstringwithoutthe0xprefix
+NETWORK_RPC_URL=wss://wss.calibration.node.glif.io/apigw/lotus/rpc/v1

.github/workflows/build.yml

@@ -4,27 +4,36 @@ on:
     branches: [master]
   pull_request:
 
+env:
+  NETWORK_PRIVATE_KEY: ${{ secrets.NETWORK_PRIVATE_KEY }}
+  NETWORK_RPC_URL: ${{ secrets.NETWORK_RPC_URL }}
+
 jobs:
   build:
-    runs-on: ubuntu-latest
+    runs-on: ["ubuntu-latest"]
     steps:
       - name: Checkout 🛎️
         uses: "actions/checkout@v4"
+        with:
+          submodules: recursive
 
       - name: Install nodejs 🔧
         uses: actions/setup-node@v3
         with:
           node-version: 22.3.0
 
+      - name: Install Foundry
+        uses: foundry-rs/foundry-toolchain@v1
+
       - name: Install dependencies
         run: npm ci
 
-      - name: Test
-        run: npm run test
-
       - name: Build
         run: npm run build
 
+      - name: Test
+        run: npm run test
+
       - name: Publish to npmjs
         uses: JS-DevTools/npm-publish@v1
         if: github.ref == 'refs/heads/master'

.gitignore

@@ -1,3 +1,7 @@
+# project files
+.env
+src/generated
+
 # Compiler files
 cache/
 out/

.gitmodules

@@ -1,3 +1,3 @@
-[submodule "contracts/lib/forge-std"]
-	path = contracts/lib/forge-std
-	url = https://github.com/foundry-rs/forge-std
+[submodule "randomness-solidity"]
+	path = randomness-solidity
+	url = https://github.com/randa-mu/randomness-solidity

README.md

@@ -1,7 +1,31 @@
-## randomness-js
+# randomness-js
 
 A convenience library for retrieving, verifying and deriving randomness from the dcrypt network.
 
 Build everything by running `npm run build`. This creates a dist directory containing commonjs and esm modules.
 
 Solidity interfaces for randomness can be found in our [solidity repo](https://github.com/randa-mu/randamu-solidity-contracts).
+
+## Usage
+First install the package by running `npm install randomness-js`
+Then create an instance of randomness for your preferred network. An example for filecoin is below:
+```javascript
+import { JsonRpcProvider, Wallet } from "ethers"
+import { Randomness } from "randomness-js"
+
+// set up your ethers objects
+const rpc = new JsonRpcProvider("https://api.calibration.node.glif.io/rpc/v1")
+const wallet = new Wallet("<YOUR PRIVATE KEY HERE>", rpc)
+
+// create and request some randomness
+const randomness = Randomness.createFilecoinCalibnet(wallet)
+const response = await randomness.requestRandomness()
+
+// the smart contracts verify the randomness anyway, but doesn't hurt to verify it for yourself to be sure :)
+await randomness.verify(response)
+```
+
+## Development
+- Clone the repo
+- run `git submodule update --init --recursive`
+For running the tests, you need to create a `.env` file at the project root filling in the fields detailed in [`.env.sample`](./.env.sample).