Geolocation npm package

The Geolocation npm package abstracts a lot of the complexity of manually requesting Proofs by providing a series of useful methods to easily check the validity of your values, sign messages and send requests to the W3bstream Node.

Installation

To install the package run:
npm i @w3bstream/geolocation-light

HIW

Create a new instance of a geolocation, like this:
const geolocation = new GeolocationVerifier()
This constructor doesn't take any parameters for testnet.
In order to call the mainnet API you'll need to specify it like this:
new GeolocationVerifier({isMainnet: true})
In order to generate a Siwe message, you'll have to first create a location, like this:
geolocation.location = {
latitude: 47.658872, // range [-90, 90]
longitude: -27.4444, // range [-180, 180]
distance: 1000, // range [0, infinity), meters
from: 1676305034021, // timestamp, unix milliseconds
to: 1676305034488 // timestamp, unix milliseconds
}
Or for scaled coordinates (e.g. latitude: 47658872, etc...), you can set a scaledLocationArea like this:
// sets location area
geolocation.scaledLocation = {
scaled_latitude: -45500000,
scaled_longitude: 123000000,
distance: 100,
from: 1676305034, // timestamp, unix seconds
to: 1676305035 // timestamp, unix seconds
}
These values will be validated under the hood, and will be used in the generateSiweMessage() method:
// generates Siwe message and returns it as a string
const msg = geolocation.generateSiweMessage({
domain: string,
uri: string,
address: string,
})
You can now use any library of choice to sign this message and retrieve its signature.
You can set the signature you just retrieved like this:
// sets the signature
geolocation.signature = "the-signature-you-just–got"
You're now ready to call the verifyLocation() method which will not need any params.
const verifiedLocation = await geolocation.verifyLocation();