@monerium/sdk

@monerium/sdk

Everything you need to interact with Monerium.

This package is in development. Please make sure to check if any future updates contain commits that may change the behaviour of your application before you upgrade.

Authentication

import { MoneriumClient } from 'monerium-js';

const client = await MoneriumClient.create();

// Depending on the authentication method you want to use,
// make sure to pass the correct arguments to the `auth` method.
// Optional arguments can be omitted.

// --- BASIC Authentication --- //

await client.auth({ email: '<required>', password: '<required>' });

// --- BEARER PKCE Authentication --- //

// 1. Redirect to Monerium PKCE Authentication flow.
await client
	.auth({
		client_id: '<required>',
		state: '<recommended>',
		address: '<optional>',
		redirect_uri: '<optional>',
		scope: '<optional>'
	})
	.then(() => {
		// store the `code_verifier` from `client.codeVerifier` for later.
		sessionStorage.setItem('code_verifier', client.codeVerifier);
	});

// User will be redirected to the redirect_url with
// the code and the state in query parameters
// Make sure to compare the state from the response and the one you passed.

// 2. Redeem Code
const bearerProfile = await client.auth({
	client_id: '<required>',
	code: '<required>',
	code_verifier: sessionStorage.getItem('code_verifier'),
	redirect_uri: '<can be omitted if not set in request>',
	scope: '<optional>'
});

// Note: In case steps 1 and 2 are executed in different environments,
// e.g. 1 in the browser and 2 on the server, you can pass a bearer
// profile in order to authenticate as shown below.

client.auth(bearerProfile);

// --- BEARER Client Authentication --- //

await client.auth({ client_id: '<required>', client_secret: '<required>', scope: '<optional>' });

// --- Client Attributes --- //

client.authContext;
client.bearerProfile;

Demo

To check out the demo site for this pacakge, run the following commands:

yarn install
yarn dev

Developing

If you want to make any code contributions, make sure to run the following commands before you pr them:

yarn format
yarn lint
yarn test

Publishing

If you want to modify and publish the package yourself, run the following commands:

yarn package
yarn publish