@windingtree/org.id

ORG.ID Registry

ORG.ID Registry is the core smart contract of the ORG.ID ecosystem. It is a list of all organizations and their organizational units. Its interface allows to retrieve information about all and any organization or unit, as well as create and change them.

Mainnet

0xC1A0A8b02351F7E3e2ebD9B5b6a80fF7cdAF93D1 full config

Warning: ownership should be transferred to DAO.

Ropsten

0xc8fD300bE7e4613bCa573ad820a6F1f0b915CfcA full config

ORG.ID Sandbox

docker run --rm -it -p 8545:8545 -p 8546:8546 -p 30303:30303 --name org.id-sandbox windingtree/org.id-sandbox

ORG.ID Sandbox docker container is the easiest way to start developing applications for the ORG.ID ecosystem.

Usage

npm i @windingtree/org.id

// ABI
const { OrgIdContract, OrgIdInterfaceContract, addresses } = require('@windingtree/org.id');
// Contract addresses
const { mainnet, ropsten } = addresses;

Interface

Auto-generated docs.

ORG.ID Record Structure

Both organization and unit records have:

Name	Type	Description
orgId	bytes32	Unique Organization ID
isActive	bool	Indicates whether ORG.ID is active
owner	address	Account (or smart contract) currently authorized to manage ORG.ID
orgJsonUri	string	URI of a ORG.JSON-compliant datasheet (example)
orgJsonHash	bytes32	ORG.JSON keccak256 hash

Additionally, unit's ORG.ID may contain:

Name	Type	Description
parentOrgId	bytes32	Unit parent's ORG.ID
director	address	Director may change unit's ORG.JSON and its hash
isDirectorshipAccepted	bool	Director must accept their role explicitly, in which case this flag is set to true

Development

Setup

npm i
npm link

Test

npm run test
npm run test ./<path_to_test_file>.js

Test coverage

npm run coverage

Linting

npm run lint

ORG.ID Ecosystem

• Winding Tree DAO controls ORG.ID Registry smart contract and some Directories (including their rules)
• ORG.ID Registry
• ORG.JSON Schema is a data format for describing organizations
• ORG.ID Resolver is an application for fetching information about organization in W3C DID format
• ORG.ID Directories are curated lists of organizations
• Arbor can be used to look up an ORG.ID, and also to create and manage your own ORG.ID