Installation

Organigram's technical stack is composed of 4 layers:

Organigram.ai: A no-code platform and Web API using NLP techniques to create and manage organigrams easily from legal documentation;
The Organigram Protocol: A suite of Ethereum smart contracts serving as the backbone of the system, with JavaScript/TypeScript and React implementations;
Passkey Wallet
hosted services;

Organigram.ai

The easiest way to get started is to use the web application. You can dive right in and unlock your wallet on the top right corner to automatically create an account.

You can also follow our guide to create a French commercial company in under 5 minutes, to have a more complete overview of the platform.

Organigram Protocol

The Organigram Protocol is the core of the Organigram stack: a suite of smart contracts implementing the basic building blocks for incorruptible organizations. It is designed to be modular and extensible, allowing developers to build on top of it and create their own custom logic.

To install the Organigram Protocol NPM Package:


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

The main concepts are covered in the Protocol section, and the complete reference is available in the contracts section of this documentation.

Organigram JS

Organigram JS is the JavaScript/TypeScript client for the Organigram Protocol, providing tools to interact with the protocol easily and safely from any JavaScript environment, both client-side and server-side. It is used under the hood at Organigram.ai and is the recommended way to interact with the protocol for most use cases.

To install Organigram JS NPM Package:


pnpm add @organigram/js

The complete reference can be found in the corresponding section of the documentation.

Organigram React

Organigram React is a set of components and hooks for building web applications on top of the Organigram Protocol. It is used in the Organigram web application to provide a seamless user experience when creating and managing incorruptible organizations.

To install Organigram React NPM Package:


pnpm add @organigram/react

You can refer to the corresponding section of the documentation for a complete reference of the available components and hooks, as well as usage examples.

Web API

Sponsored transactions facilitate the use of decentralized networks for any non-financial operations.

Organigram Web API can be accessed at:


https://organigram.ai/api

See REST API Reference for more details.

Basic Usage

Initialization

To initialize Organigram in your app, you need to load a 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 }

Deploy an organ

Then, to deploy an organ, you can do:

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)

Deploy a procedure

To create a new procedure, it's not much harder:

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)