@ixo/client-sdk

ixo-client SDK

A complete package of client software for developing client applications which connect to the ixo software stack and build on the Internet of Impact.

Usage Example

const {makeWallet, makeClient} = require('@ixo/client-sdk')

const
    wallet = await makeWallet(),
    client = makeClient(wallet)

await client.register()

await client.sendTokens('<target address>', 10)

const someProject = await client.getProject('<a valid project DID>')

const someClaims = await client.listClaims(someProject)
console.log('Here are the claims', someClaims)

See client API and wallet API for details.

Client API

• makeClient to create a new client

Client methods:

• register
• getSecpAccount
• getAgentAccount
• sendTokens
• getDidDoc
• listProjects
• listTemplates
• listCells
• getProject
• getTemplate
• getCell
• createProject
• createProjectFile
• getProjectFile
• listAgents
• createAgent
• updateAgentStatus
• listClaims
• createClaim
• evaluateClaim
• custom

Create a new client

• makeClient(signer, blockchainURL, blocksyncURL): Create a new ixo client

  • signer: Either a wallet object created by makeWallet or a custom signer object with the following properties:

    • secp: Object with the following properties:

      • address
      • sign(address, document)

    • agent: Object with the following properties:

      • did
      • address
      • sign(address, document)

    See the wallet API for more info on secp and agent keywords.

    Optional. If empty, client methods that require a signer won't work.

  • blockchainURL: The URL of the target ixo chain. Optional, defaults to the current mainnet URL.

  • blocksyncURL: The URL of the target ixo blocksync service. Optional, defaults to the current main blocksync service URL.

Client methods

• register(verifyKey): Register the current user

  • verifyKey: Only required if the client is configured to use a custom signer. No need to provide this if the client is initialized with a wallet created with makeWallet, as the value can be obtained from it.

• getSecpAccount(): Get account info for the SECP subwallet

• getAgentAccount(): Get account info for the agent subwallet

• sendTokens(targetAddress, amount, denom)

  • targetAddress: A wallet address to send coins to

  • amount: Any positive number

  • denom: Coin type. Optional, defaults to "uixo".

• getDidDoc(did): Return the full DID document for the given DID

• listProjects(): Lists all available projects

• listTemplates(): Lists all available templates

• listCells(): Lists all available cells

• getProject(projectDid): Get complete project record for the given DID

• getTemplate(tplDid): Get complete template record for the given DID

• getCell(cellDid): Get complete cell record for the given DID

• createProject(projectData, cellnodeURL): Create a new project

  • projectData: To be documented; for now please see here for an example

  • cellnodeURL: URL of the cell node where various project data will be kept. Optional, defaults to the URL of ixo's shared cell node

• createProjectFile(target, dataUrl): Upload a file to project's cell node

  • target: Either a project record, a project DID, or a cell node URL

  • dataUrl: Any valid data URL

• getProjectFile(target, key)

  • target: Either a project record, a project DID, or a cell node URL

  • key: Key of the target file, as returned from createProjectFile.

• listAgents(projectRecordOrDid): List agents belonging to a given project

• createAgent(projectRecordOrDid, agentRecord): Create an agent for the given project

  • agentRecord: An object with the following properties:

    • did: The DID of an already registered user

    • email: Agent email

    • name: Agent name

    • role: Any one of the following:

      • "PO" for owner
      • "EA" for evaluator
      • "SA" for service provider
      • "IA" for investor

• updateAgentStatus(projectRecordOrDid, agentDid, updates)

  • updates: An object with the following properties:

    • status: Any one of the following:

      • 0 for pending
      • 1 for approved
      • 2 for revoked
      • 3 for invited

    • role: See the role property under createAgent

    • version: Optional

• listClaims(projectRecordOrDid, projectTemplateId)

  • projectTemplateId: Optional, provide a value to filter claims by template id

• createClaim(projectRecordOrDid, claimData)

  • claimData: Any object is accepted

• evaluateClaim(projectRecordOrDid, claimId, status)

  • claimId: A claim id as returned from createClaim

  • status: Any one of the following:

    • 0 for pending
    • 1 for approved
    • 2 for rejected

• custom(walletType, msg): Send a custom message to the blockchain

  • walletType: Either "secp" or "agent". See the wallet API for more info

  • msg: See here for available options

Wallet API

makeWallet(source, serializationPwd): Create a new wallet

• source: Either a mnemonic string, a serialized wallet string, or a plain object representing a wallet state (possibly obtained via toJSON() -see below for details). Optional.

  If empty, a brand new wallet is generated. If a mnemonic string, recovers a wallet based on the mnemonic. If serialized wallet, deserializes it. If a state object, revives the wallet using that state.

• serializationPwd: Serializations involve encryption so a password is required if the first parameter is an encryption string.

makeWallet returns a wallet object with the following properties:

• secp: An instance of CosmJS' Secp256k1HdWallet

• agent: An instance of IxoAgentWallet which is a subclass of Secp256k1HdWallet and 100% API compatible with it.

• toJSON(): Standard toJSON method for JSON.stringify integration. One can also use this to get a representation of the wallet's internal state as a plain object and use it in a context where a class instance is not supported. (e.g. Global application state of a client app)

Debugging

Put the ixo-client-sdk string into your DEBUG environment variable to log network requests and responses. See the debug package for more info.