Installation

La pile technique d'Organigram est composée de 4 couches :

Organigram.ai : une plateforme sans code et une API Web utilisant des techniques de NLP pour créer et gérer facilement des organigrammes à partir de la documentation juridique ;
Le Protocole Organigram: Une suite de Smart contracts Ethereum qui constitue la colonne vertébrale du système, avec des implémentations JavaScript/TypeScript et React ;
Passkey Wallet
services hébergés;

Organigram.ai

La façon la plus simple de commencer est d'utiliser l'application web. Vous pouvez directement vous lancer et déverrouiller votre portefeuille en haut à droite pour créer automatiquement un compte.

Vous pouvez également suivre notre guide pour créer une société commerciale française en moins de 5 minutes pour avoir un aperçu plus complet de la plateforme.

Protocole Organigram

Le Protocole Organigram est le cœur de la pile Organigram : un ensemble de contrats intelligents implémentant les blocs de base pour des organisations incorruptibles. Il est conçu pour être modulaire et extensible, permettant aux développeurs de construire dessus et de créer leur propre logique personnalisée.

Pour installer le Package NPM Organigram Protocol:


# Using npm
npm install @organigram/protocol
# Using pnpm
pnpm add @organigram/protocol

Les principaux concepts sont couverts dans la Protocole section, et la référence complète est disponible dans la section des contrats de cette documentation.

Organigram JS

Organigram JS est le client JavaScript/TypeScript pour le Protocole Organigram, fournissant des outils pour interagir avec le protocole de manière facile et sécurisée depuis tout environnement JavaScript, tant côté client que côté serveur. Il est utilisé en interne dans Organigram.ai et est la méthode recommandée pour interagir avec le protocole pour la plupart des cas d'utilisation.

Pour installer Package NPM Organigram JS:


pnpm add @organigram/js

La référence complète se trouve dans la section correspondante de la documentation.

Organigram React

Organigram React est un ensemble de composants et de hooks pour construire des applications web sur le Protocole Organigram. Il est utilisé dans le Application web Organigram pour offrir une expérience utilisateur fluide lors de la création et de la gestion d'organisations incorruptibles.

Pour installer Organigram React NPM Package:


pnpm add @organigram/react

Vous pouvez consulter la section correspondante de la documentation pour une référence complète des composants et hooks disponibles, ainsi que des exemples d'utilisation.

API Web

Transactions sponsorisées facilitent l'utilisation des réseaux décentralisés pour toute opération non financière.

L'API Web Organigram peut être accédée à l'adresse :


https://organigram.ai/api

Voir Référence de l'API REST pour plus de détails.

Utilisation de base

Initialisation

Pour initialiser Organigram dans votre application, vous devez charger un client :

init.js


import { OrganigramClient } from '@organigram/js'
import { createPublicClient, createWalletClient, http } from 'viem'
import { privateKeyToAccount } from 'viem/accounts'
const publicClient = createPublicClient({ transport: http(process.env.ETHEREUM_PROVIDER) })
const walletClient = createWalletClient({ account: privateKeyToAccount('0xPrivateKeyExample'), transport: http(process.env.ETHEREUM_PROVIDER) })
const organigramClient = await OrganigramClient.load({ publicClient, walletClient })
export { organigramClient }

Déployer un organe

Ensuite, pour déployer un organe, vous pouvez faire :

newOrgan.js


import { organigramClient } from './initOrganigramClient'
const organMetadata = '' // Optional: provide a CID for the organ metadata stored on IPFS or similar
const salt = 'unique-salt-value' // Optional: provide a unique salt for deterministic address.
const newOrgan = await organigramClient.deployOrgan({
  cid: organMetadata,
  permissions: [], // Passing an empty array or no argument for permissions will create an organ with the signer as owner.
  salt
})
console.info(newOrgan)

Déployer une procédure

Pour créer une nouvelle procédure, ce n'est pas beaucoup plus difficile :

newProcedure.js


import { createRandom32BytesHexId } from '@organigram/js'
import { organigramClient } from './initOrganigramClient'
const typeName = 'nomination'
const deciders = '0x1234AdressFromSomeOrgan'
const salt = createRandom32BytesHexId() // Creates a correctly formatted random salt
const newProcedure = await organigramClient.deployProcedure({
  typeName,
  deciders,
  salt
})
console.info(newProcedure)

Pour savoir ce que vous pouvez faire avec eux, consultez Protocole pour une vue d'ensemble, ou plongez dans la API clients pour une exploration approfondie de la bibliothèque.

Modifier cette page