@enc-protocol/cloud — SDK Reference

npm install @enc-protocol/cloud --registry https://npm-registry.ocrybit.workers.dev/

import { CloudClient } from '@enc-protocol/cloud'
 
const cloud = new CloudClient('https://enc-cloud.ocrybit.workers.dev', myPubKeyHex)
 
// Deploy an enclave
const { data } = await cloud.deployEnclave('Personal', 'My Personal')
console.log('Enclave:', data.enclave_id)
 
// Check billing
const { data: billing } = await cloud.getBillingUsage()
console.log('Due:', billing.due_usdt, 'USDT')

new CloudClient(baseUrl, pubKey?)

const { data } = await cloud.getTemplates()
// [{ id: 'Personal', name: 'Personal', description: '...' }, ...]

const { data } = await cloud.getConfig('usdt_address')
// { key: 'usdt_address', value: '0x5fbd...' }

const { data } = await cloud.getFaucetWhitelist()
// { whitelist: ['0x...', ...], open: true }

const { data } = await cloud.getFaucetClaim('0x1234...')
// { claimed: false } or { claimed: true, eth_tx: '...', usdt_tx: '...', ... }

const { data } = await cloud.register(pubKeyHex, 'Alice')
// { ok: true, pub_key: '...' }

const { data } = await cloud.deployEnclave('Personal', 'My Vault')
// {
//   enclave_id: '64-hex',
//   seq_pub: '64-hex (node public key)',
//   template: 'Personal',
//   node_id: 'shared-1',
//   node_url: 'https://enc-node.ocrybit.workers.dev',
//   name: 'My Vault'
// }

const { data } = await cloud.listEnclaves()
// [{ enclave_id, template, node_id, node_url, node_type, name, status, created_at }, ...]

const { data } = await cloud.deleteEnclave(enclaveId)
// { ok: true, enclave_id: '...', status: 'stopped' }

await cloud.registerEnclave(enclaveId, 'custom', 'shared-1', 'My Custom')

const { data } = await cloud.listNodes()
// [{ node_id: 'shared-1', type: 'shared', url: '...', enc_v: 2, status: 'running' }]

const { data } = await cloud.getBillingUsage()
// {
//   enclaves: [{ enclave_id, name, events, cost_usdt }],
//   total_events: 301,
//   paid_events: 0,
//   due_events: 301,
//   price_per_event: 0.001,
//   currency: 'USDT',
//   gross_usdt: 0.301,
//   paid_usdt: 0,
//   due_usdt: 0.301,
//   treasury: '0xf39F...',
//   usdt_address: '0x5fbd...'
// }

const { data } = await cloud.recordPayment('0x...')
// { ok: true, tx_hash: '0x...', amount: '0.301', events_billed: 301, chain_id: 31340 }

const { data } = await cloud.listPayments()
// [{ id, pub_key, tx_hash, amount, currency, events_billed, chain_id, status, created_at }]

const { data } = await cloud.getUsage()
// { enclaves: 3, dedicated_nodes: 0, events_total: 0, storage_bytes: 0 }

const { data } = await cloud.claimFaucet('0x1234...')
// { ok: true, address: '0x...', eth_tx: null, usdt_tx: '0x...', eth_wei: '0x...', usdt_units: '0x...' }

await cloud.setConfig('usdt_address', '0x...', adminToken)

await cloud.addToWhitelist('0x...', adminToken)

await cloud.removeFromWhitelist('0x...', adminToken)

const { status, data } = await cloud.deployEnclave('Bad')
if (status !== 200) {
  console.error(data.error) // "Unknown template: Bad. Available: Hello, DM, ..."
}