@monerium/sdk 1.0.20 → 2.0.0-alpha

package/src/lib/client.ts

@@ -1,341 +0,0 @@
-import { MONERIUM_CONFIG } from './config';
-import type { ethers } from 'ethers';
-import { providers } from '@0xsequence/multicall';
-import getPkce from 'oauth-pkce';
-import pjson from './../../package.json';
-
-type SupportedProvider = ethers.providers.Web3Provider | ethers.providers.JsonRpcProvider;
-
-type CurrencyCode = 'eur' | 'gbp' | 'usd' | 'isk';
-
-type Network = 'mainnet' | 'ropsten' | 'rinkeby' | 'kovan' | 'goerli' | 'mumbai';
-
-type Chain = 'ethereum' | 'polygon';
-interface BasicRedeem {
-	email: string;
-	password: string;
-}
-
-interface PKCERequest {
-	client_id: string;
-	code_challenge?: string;
-	code_challenge_method?: string;
-	response_type?: string;
-	redirect_uri?: string;
-	state?: string;
-	address?: string;
-	scope?: string;
-}
-
-interface PKCERedeem {
-	client_id: string;
-	code: string;
-	code_verifier: string;
-	grant_type?: string;
-	redirect_uri?: string;
-	scope?: string;
-}
-
-interface ClientRedeem {
-	client_id: string;
-	client_secret: string;
-	scope?: string;
-	grant_type?: string;
-}
-
-interface BearerProfile {
-	access_token: string;
-	token_type: string;
-	expires_in: number;
-	refresh_token: string;
-	profile: string;
-	userId: string;
-}
-
-interface AuthContext {
-	userId: string;
-	email: string;
-	name: string;
-	roles: [string];
-	auth: { method: string; subject: string; verified: boolean };
-	defaultProfile: string;
-	profiles: [{ id: string; type: string; name: string; perms: [string] }];
-}
-
-interface CurrencyAccounts {
-	network: Network;
-	chain: Chain;
-	currency: CurrencyCode;
-}
-interface ConnectWalletPayload {
-	address: string;
-	message: string;
-	signature: string;
-	accounts: CurrencyAccounts[];
-}
-
-interface PlaceOrderPayloadByAccount {
-	accountId: string;
-}
-interface PlaceOrderPayloadByAddress {
-	address: string;
-	currency: CurrencyCode;
-}
-
-interface CounterpartDetailsIndividual {
-	firstName: string;
-	lastName: string;
-}
-
-interface CounterpartDetailsCorporation {
-	companyName: string;
-}
-
-interface CounterpartIdentifierBase {
-	standard: 'iban' | 'scan';
-}
-interface CounterpartIdentifierIban extends CounterpartIdentifierBase {
-	standard: 'iban';
-	iban: string;
-}
-interface CounterpartIdentifierScan extends CounterpartIdentifierBase {
-	standard: 'scan';
-	sortCode: string;
-	accountNumber: string;
-}
-
-type CounterpartIdentifier = CounterpartIdentifierIban | CounterpartIdentifierScan;
-
-type CounterpartDetails = CounterpartDetailsIndividual | CounterpartDetailsCorporation;
-interface Counterpart {
-	identifier: CounterpartIdentifier;
-	details: CounterpartDetails;
-}
-interface PlaceOrderPayloadBase {
-	kind: 'redeem' | 'issue';
-	amount: string;
-	signature: string;
-	counterpart: Counterpart;
-	message: string;
-	memo?: string;
-	supportingDocumentId?: string;
-	chain?: string;
-	network?: string;
-
-	// TODO:  https://monerium.dev/api-docs#operation/post-profile-orders
-}
-
-type PlaceOrderPayload = PlaceOrderPayloadBase &
-	(PlaceOrderPayloadByAccount | PlaceOrderPayloadByAddress);
-
-interface SupportingDocumentPayload {
-	file: File;
-}
-
-export class MoneriumClient {
-	#env!: { base: string; web: string };
-	#provider?: ethers.providers.Provider;
-	#signer?: ethers.Signer;
-	#authPayload?: string;
-	codeVerifier?: string;
-
-	bearerProfile?: BearerProfile;
-	authContext?: AuthContext;
-
-	// --- Constructor --- //
-
-	static async create(env: 'production' | 'sandbox' = 'sandbox', provider?: SupportedProvider) {
-		const client = new MoneriumClient();
-
-		await client.#initialize(env, provider);
-
-		return client;
-	}
-
-	async #initialize(env: 'production' | 'sandbox', provider?: SupportedProvider) {
-		this.#env = MONERIUM_CONFIG.environments[env];
-
-		if (provider) {
-			this.#provider = new providers.MulticallProvider(provider);
-			this.#signer = provider.getSigner();
-		}
-	}
-
-	// --- Private Helper Methods --- //
-
-	async #api(
-		method: string,
-		resource: string,
-		data?:
-			| PKCERequest
-			| PKCERedeem
-			| ClientRedeem
-			| ConnectWalletPayload
-			| PlaceOrderPayload
-			| SupportingDocumentPayload,
-		isFormEncoded?: boolean
-	) {
-		const res = await fetch(`${this.#env.base}/${resource}`, {
-			method,
-			headers: {
-				// To understand SDK adoption and correlate issues to specific versions.
-				'User-Agent': 'monerium-sdk/' + pjson.version,
-				'content-type': isFormEncoded ? 'application/x-www-form-urlencoded' : 'application/json',
-				Authorization: this.#authPayload || ''
-			},
-			body:
-				data && isFormEncoded
-					? new URLSearchParams(data as unknown as Record<string, string>)
-					: JSON.stringify(data)
-		});
-
-		if (res.status >= 200 && res.status <= 299) {
-			return await res.json();
-		} else {
-			return new Error(res.statusText);
-		}
-	}
-
-	#isPKCERequest(
-		args: PKCERequest | BearerProfile | BasicRedeem | PKCERedeem | ClientRedeem
-	): args is PKCERequest {
-		return (args as PKCERequest).client_id != undefined && (args as PKCERedeem)?.code === undefined;
-	}
-
-	#isBearerProfileAuth(
-		args: BearerProfile | BasicRedeem | PKCERedeem | ClientRedeem
-	): args is BearerProfile {
-		return (args as BearerProfile).access_token != undefined;
-	}
-
-	#isBasicAuth(args: BasicRedeem | PKCERedeem | ClientRedeem): args is BasicRedeem {
-		return (args as BasicRedeem).password != undefined;
-	}
-
-	#isPKCEAuth(args: PKCERedeem | ClientRedeem): args is PKCERedeem {
-		return (args as PKCERedeem).code != undefined;
-	}
-
-	#isClientAuth(args: ClientRedeem): args is ClientRedeem {
-		return (args as ClientRedeem).client_secret != undefined;
-	}
-
-	// --- Public Methods --- //
-
-	async auth(args: PKCERequest | BearerProfile | BasicRedeem | PKCERedeem | ClientRedeem) {
-		if (this.#isPKCERequest(args)) {
-			const { verifier, challenge } = await new Promise<{ verifier: string; challenge: string }>(
-				(resolve) => {
-					getPkce(43, (error, { verifier, challenge }) => {
-						if (error) throw error;
-						resolve({ verifier, challenge });
-					});
-				}
-			);
-
-			const requestData = {
-				client_id: args?.client_id,
-				code_challenge: challenge,
-				code_challenge_method: 'S256',
-				response_type: 'code',
-				redirect_uri: args.redirect_uri || '',
-				scope: args.scope || 'orders:read',
-				state: args.state || '',
-				address: args.address || ''
-			};
-			this.codeVerifier = verifier;
-			this.#authPayload = ' ';
-
-			if (typeof window !== 'undefined') {
-				return window.location.replace(
-					`${this.#env.base}/auth?${new URLSearchParams(requestData).toString()}`
-				);
-			}
-			return new Error('Something went wrong. Please contact the Monerium Support team.');
-		} else {
-			if (this.#isBearerProfileAuth(args)) {
-				this.bearerProfile = args;
-				this.#authPayload = this.bearerProfile && `Bearer ${this.bearerProfile.access_token}`;
-			} else if (this.#isBasicAuth(args)) {
-				const bufferObj = Buffer.from(`${args.email}:${args.password}`, 'utf8');
-				this.#authPayload = `Basic ${bufferObj.toString('base64')}`;
-			} else if (this.#isPKCEAuth(args)) {
-				const redeemData: PKCERedeem = {
-					client_id: args.client_id,
-					code: args.code,
-					redirect_uri: args.redirect_uri,
-					grant_type: 'authorization_code',
-					code_verifier: args.code_verifier,
-					scope: args.scope || 'orders:read'
-				};
-
-				this.bearerProfile = await this.#api('post', 'auth/token', redeemData, true);
-				this.#authPayload = this.bearerProfile && `Bearer ${this.bearerProfile.access_token}`;
-			} else if (this.#isClientAuth(args)) {
-				const redeemData: ClientRedeem = {
-					client_id: args.client_id,
-					client_secret: args.client_secret,
-					grant_type: 'client_credentials',
-					scope: args.scope || 'orders:read'
-				};
-
-				this.bearerProfile = await this.#api('post', 'auth/token', redeemData, true);
-				this.#authPayload = this.bearerProfile && `Bearer ${this.bearerProfile.access_token}`;
-			} else {
-				return new Error('Something went wrong. Please contact the Monerium Support team.');
-			}
-
-			this.authContext = await this.getAuthContext();
-		}
-	}
-
-	async getAuthContext() {
-		return await this.#api('get', 'auth/context');
-	}
-
-	async getProfile(profileId: string) {
-		return await this.#api('get', `profiles/${profileId}`);
-	}
-
-	async getOrders(profileId?: string) {
-		if (profileId) {
-			return await this.#api('get', `profiles/${profileId}/orders`);
-		} else {
-			return await this.#api('get', `orders`);
-		}
-	}
-
-	async getOrder(orderId: string) {
-		return await this.#api('get', `orders/${orderId}`);
-	}
-
-	async getBalances(profileId?: string) {
-		if (profileId) {
-			return await this.#api('get', `profiles/${profileId}/balances`);
-		} else {
-			return await this.#api('get', 'balances');
-		}
-	}
-	async getTokens() {
-		return await this.#api('get', 'tokens');
-	}
-
-	async connectWallet(profileId: string, body: ConnectWalletPayload) {
-		return await this.#api('post', `profiles/${profileId}/address`, body);
-	}
-
-	async placeOrder(body?: PlaceOrderPayload, profileId?: string) {
-		if (profileId) {
-			return await this.#api('post', `profiles/${profileId}/orders`, body);
-		} else {
-			return await this.#api('post', `orders`, body);
-		}
-	}
-
-	async uploadSupportingDocument(body: SupportingDocumentPayload) {
-		return await this.#api('post', `files/supporting-document`, body, true);
-	}
-	// orderNotifications websockets?
-	// https://monerium.dev/api-docs#operation/profile-orders-notifications
-	// https://monerium.dev/api-docs#operation/orders-notifications
-}

package/src/lib/config.ts

@@ -1,59 +0,0 @@
-type Tokens = {
-	EUR: string;
-	GBP: string;
-	USD: string;
-	ISK: string;
-};
-
-type TokenConfig = {
-	contract: string;
-	ens?: string;
-};
-
-type MoneriumConfig = {
-	deployments: { [chainId: number]: { [Property in keyof Tokens]: TokenConfig } };
-	environments: {
-		[env: string]: { base: string; web: string };
-	};
-};
-
-export const MONERIUM_CONFIG: MoneriumConfig = {
-	deployments: {
-		1: {
-			EUR: {
-				contract: '0x3231cb76718cdef2155fc47b5286d82e6eda273f',
-				ens: 'eur.monerium.eth'
-			},
-			GBP: {
-				contract: '0x7ba92741bf2a568abc6f1d3413c58c6e0244f8fd',
-				ens: 'gbp.monerium.eth'
-			},
-			USD: {
-				contract: '0xbc5142e0cc5eb16b47c63b0f033d4c2480853a52',
-				ens: 'usd.monerium.eth'
-			},
-			ISK: {
-				contract: '0xc642549743a93674cf38d6431f75d6443f88e3e2',
-				ens: 'isk.monerium.eth'
-			}
-		},
-		4: {
-			EUR: {
-				contract: '0x25c13fc529dc4afe4d488bd1f2ee5e1ec4918e0b'
-			},
-			GBP: {
-				contract: '0x01df10e345d0364d3a5b8422a66af6305803bd1e'
-			},
-			USD: {
-				contract: '0x09c0a236e1227500f495cb0731c4af69b49639a5'
-			},
-			ISK: {
-				contract: '0x0c9d7a0d8bf4bc9d15f577bbf650ebc8044a71db'
-			}
-		}
-	},
-	environments: {
-		production: { base: 'https://api.monerium.app', web: 'https://monerium.app' },
-		sandbox: { base: 'https://api.monerium.dev', web: 'https://sandbox.monerium.dev' }
-	}
-};

package/src/lib/index.ts

@@ -1 +0,0 @@
-export { MoneriumClient } from './client';

package/src/routes/index.svelte

@@ -1,32 +0,0 @@
-<script lang="ts">
-	import { onMount } from 'svelte';
-	import { MoneriumClient } from 'monerium-js';
-
-	let client: MoneriumClient;
-
-	onMount(async () => {
-		client = await MoneriumClient.create();
-	});
-
-// client Credential:
-// id: 654c9c30-44d3-11ed-adac-b2efc0e6677d
-// secret: ac474b7cdc111973aa080b0428ba3a824e82119bee8f65875b4aba0d42416dff
-
-	async function authenticate() {
-		await client.auth({
-			client_id: '654c9c30-44d3-11ed-adac-b2efc0e6677d',
-			// partner_name: 'piedpiper',
-			redirect_uri: 'http://localhost:5173/integration'
-		}).then(() => {
-			if (typeof window !== "undefined" && client?.codeVerifier) {
-				sessionStorage.setItem("code_verifier", client.codeVerifier)
-				console.log('%cadding codeVerifier to session storage', 'color:white; padding: 30px; background-color: darkgreen', client.codeVerifier)
-			}
-		});
-		
-		
-	}
-</script>
-
-<h1>This is a demo of the Monerium JavaScript SDK.</h1>
-<button on:click={authenticate}>Login</button>

package/src/routes/integration.svelte

@@ -1,45 +0,0 @@
-<script lang="ts">
-	import { afterUpdate, onMount } from 'svelte';
-	import { MoneriumClient } from 'monerium-js';
-
-	let client: MoneriumClient;
-	let codeVerifier: string;
-	let authContext = undefined;
-	const urlParams = typeof window !== "undefined" ? new URLSearchParams(window.location.search) : undefined;
-
-	console.log('%curlParams', 'color:white; padding: 30px; background-color: darkgreen', urlParams?.get('code'))
-	
-	onMount(async () => {
-		client = await MoneriumClient.create();
-		codeVerifier = sessionStorage?.getItem("code_verifier") || '' ;
-		console.log('%ccodeVerifier from session storage', 'color:white; padding: 30px; background-color: darkgreen', codeVerifier)
-	});
-
-	afterUpdate(() => authContext = client?.authContext)
-
-// client Credential:
-// id: 654c9c30-44d3-11ed-adac-b2efc0e6677d
-// secret: ac474b7cdc111973aa080b0428ba3a824e82119bee8f65875b4aba0d42416dff
-async function authenticate() {
-	client.auth({
-		code: urlParams?.get('code') || '',
-		grant_type: 'authorization_code',
-		code_verifier: codeVerifier,
-		client_id: '654c9c30-44d3-11ed-adac-b2efc0e6677d',
-		// partner_name: 'piedpiper',
-		redirect_uri: 'http://localhost:5173/integration'
-	});
-}
-
-async function getBalances() {
-	client.getBalances();
-}
-
-</script>
-
-<h1>Partner redirect demo page</h1>
-<p>{authContext}</p>
-<button on:click={authenticate}>authenticate</button>
-<button on:click={getBalances}>get balances</button>
-
-

package/svelte.config.js

@@ -1,19 +0,0 @@
-import adapter from '@sveltejs/adapter-auto';
-import preprocess from 'svelte-preprocess';
-
-/** @type {import('@sveltejs/kit').Config} */
-const config = {
-	// Consult https://github.com/sveltejs/svelte-preprocess
-	// for more information about preprocessors
-	preprocess: preprocess(),
-
-	kit: {
-		adapter: adapter(),
-		package: {
-			files: (file) => !file.startsWith('demo'),
-			exports: (file) => file === 'index.js'
-		}
-	}
-};
-
-export default config;

package/test/index.test.ts

@@ -1,20 +0,0 @@
-import { describe, expect, it } from 'vitest';
-import { MoneriumClient } from '../src/lib/index';
-
-const bearerClientArgs = {
-	client_id: '1234567890abcdef',
-	client_secret: '1234567890abcdef1234567890abcdef'
-};
-
-describe('Monerium Client Tests', () => {
-	it('should authenticate with client secret', async () => {
-		const client = await MoneriumClient.create();
-
-		await client.auth(bearerClientArgs);
-
-		expect(client.authContext).toHaveProperty('email', 'simon.ibars@request.network');
-	}, 100000);
-
-	it.todo('should authenticate with PKCE flow');
-	it.todo('should authenticate with user credentials');
-});

package/tsconfig.json

@@ -1,19 +0,0 @@
-{
-	"extends": "./.svelte-kit/tsconfig.json",
-	"compilerOptions": {
-		"allowJs": true,
-		"checkJs": true,
-		"esModuleInterop": true,
-		"forceConsistentCasingInFileNames": true,
-		"resolveJsonModule": true,
-		"skipLibCheck": true,
-		"sourceMap": true,
-		"strict": true,
-		"paths": {
-			"$lib": ["src/lib"],
-			"$lib/*": ["src/lib/*"],
-			"monerium-js": ["src/lib/index.ts"],
-			"monerium-js/*": ["src/lib/*"]
-		}
-	}
-}

package/vite.config.js

@@ -1,14 +0,0 @@
-import { sveltekit } from '@sveltejs/kit/vite';
-import path from 'path';
-
-/** @type {import('vite').UserConfig} */
-const config = {
-	plugins: [sveltekit()],
-	resolve: {
-		alias: {
-			'monerium-js': path.resolve('src/lib')
-		}
-	}
-};
-
-export default config;

package/vitest.config.ts

@@ -1,7 +0,0 @@
-import { defineConfig } from 'vitest/config';
-
-export default defineConfig({
-	test: {
-		// ...
-	}
-});