Class OrchestrateClient

Hierarchy

OrchestrateClient

Constructors

constructor

new OrchestrateClient(host: string): OrchestrateClient

- Defined in src/client/OrchestrateClient.ts:14
Creates a new OrchestrateClient instance

Parameters
- host: string
  
  URL and port of the Orchestrate API
Returns OrchestrateClient

Methods

createAccount

createAccount(request?: types.ICreateAccountRequest, authToken?: undefined | string, headers?: IHeaders): Promise<IAccount>

- Defined in src/client/OrchestrateClient.ts:412
Creates a new account

Parameters
- Optional request: types.ICreateAccountRequest
  
  account creation request data
- Optional authToken: undefined | string
  
  Bearer token. Required when multi-tenancy is enabled
- Optional headers: IHeaders
  
  HTTP request headers.
Returns Promise<IAccount>

deleteChain

deleteChain(chainUUID: string, authToken?: undefined | string, headers?: IHeaders): Promise<void>

- Defined in src/client/OrchestrateClient.ts:238
Delete a registered chain

Parameters
- chainUUID: string
  
  uuid of registered chain
- Optional authToken: undefined | string
  
  Bearer token. Required when multi-tenancy is enabled
- Optional headers: IHeaders
  
  HTTP request headers.
Returns Promise<void>

deployContract

deployContract(deployRequest: IDeployContractRequest, idempotencyKey?: undefined | string, authToken?: undefined | string, headers?: IHeaders): Promise<ITransaction>

- Defined in src/client/OrchestrateClient.ts:78
Deploy contract request

Parameters
- deployRequest: IDeployContractRequest
  
  deploy contract request data
- Optional idempotencyKey: undefined | string
  
  Optional transaction unique identifier
- Optional authToken: undefined | string
  
  Bearer token. Required when multi-tenancy is enabled
- Optional headers: IHeaders
  
  HTTP request headers.
Returns Promise<ITransaction>

getAccount

getAccount(address: string, authToken?: undefined | string, headers?: IHeaders): Promise<IAccount>

- Defined in src/client/OrchestrateClient.ts:392
Fetch an account by address

Parameters
- address: string
  
  account's Ethereum address
- Optional authToken: undefined | string
  
  Bearer token. Required when multi-tenancy is enabled
- Optional headers: IHeaders
  
  HTTP request headers.
Returns Promise<IAccount>

getContract

getContract(name: string, tag?: undefined | string, authToken?: undefined | string, headers?: IHeaders): Promise<IContract>

- Defined in src/client/OrchestrateClient.ts:326
Fetch a contract by name and tag

Parameters
- name: string
  
  Contract name
- Optional tag: undefined | string
  
  Contract tag
- Optional authToken: undefined | string
  
  authorization token
- Optional headers: IHeaders
  
  HTTP request headers.
Returns Promise<IContract>

the contract details

getContractTags

getContractTags(name: string, authToken?: undefined | string, headers?: IHeaders): Promise<string[]>

- Defined in src/client/OrchestrateClient.ts:304
Gets all the tags of a contract by name

Parameters
- name: string
  
  Contract name
- Optional authToken: undefined | string
  
  authorization token
- Optional headers: IHeaders
  
  HTTP request headers.
Returns Promise<string[]>

the tags of the contract

getContractsCatalog

getContractsCatalog(authToken?: undefined | string, headers?: IHeaders): Promise<string[]>

- Defined in src/client/OrchestrateClient.ts:285
Fetch a list of registered contract names

Parameters
- Optional authToken: undefined | string
  
  Bearer token. Required when multi-tenancy is enabled
- Optional headers: IHeaders
  
  HTTP request headers.
Returns Promise<string[]>

getTransaction

getTransaction(txUUID: string, authToken?: undefined | string, headers?: IHeaders): Promise<ITransaction>

- Defined in src/client/OrchestrateClient.ts:32
Fetch a transaction by UUID

Parameters
- txUUID: string
  
  transaction UUID
- Optional authToken: undefined | string
  
  Bearer token. Required when multi-tenancy is enabled
- Optional headers: IHeaders
  
  HTTP request headers.
Returns Promise<ITransaction>

importAccount

importAccount(request: IImportAccountRequest, authToken?: undefined | string, headers?: IHeaders): Promise<IAccount>

- Defined in src/client/OrchestrateClient.ts:431
Imports an account

Parameters
- request: IImportAccountRequest
  
  account import request data
- Optional authToken: undefined | string
  
  Bearer token. Required when multi-tenancy is enabled
- Optional headers: IHeaders
  
  HTTP request headers.
Returns Promise<IAccount>

registerChain

registerChain(chainRequest: IRegisterChainRequest, authToken?: undefined | string, headers?: IHeaders): Promise<IChain>

- Defined in src/client/OrchestrateClient.ts:200
Register a new chain

Parameters
- chainRequest: IRegisterChainRequest
  
  register chain request data
- Optional authToken: undefined | string
  
  Bearer token. Required when multi-tenancy is enabled
- Optional headers: IHeaders
  
  HTTP request headers.
Returns Promise<IChain>

registerContract

registerContract(contractRequest: IRegisterContractRequest, authToken?: undefined | string, headers?: IHeaders): Promise<IContract>

- Defined in src/client/OrchestrateClient.ts:348
Register a new contract

Parameters
- contractRequest: IRegisterContractRequest
  
  register contract request payload
- Optional authToken: undefined | string
  
  Bearer token. Required when multi-tenancy is enabled
- Optional headers: IHeaders
  
  HTTP request headers.
Returns Promise<IContract>

registerFaucet

registerFaucet(faucetRequest: IRegisterFaucetRequest, authToken?: undefined | string, headers?: IHeaders): Promise<IFaucet>

- Defined in src/client/OrchestrateClient.ts:268
Register a faucet account

Parameters
- faucetRequest: IRegisterFaucetRequest
  
  register faucet request data
- Optional authToken: undefined | string
  
  Bearer token. Required when multi-tenancy is enabled
- Optional headers: IHeaders
  
  HTTP request headers.
Returns Promise<IFaucet>

searchAccounts

searchAccounts(searchRequest?: types.ISearchAccountsRequest, authToken?: undefined | string, headers?: IHeaders): Promise<IAccount[]>

- Defined in src/client/OrchestrateClient.ts:367
Search for accounts

Parameters
- Optional searchRequest: types.ISearchAccountsRequest
  
  accounts search filters
- Optional authToken: undefined | string
  
  Bearer token. Required when multi-tenancy is enabled
- Optional headers: IHeaders
  
  HTTP request headers.
Returns Promise<IAccount[]>

searchChains

searchChains(authToken?: undefined | string, headers?: IHeaders): Promise<IChain[]>

- Defined in src/client/OrchestrateClient.ts:183
Fetch list of registered chains

Parameters
- Optional authToken: undefined | string
  
  Bearer token. Required when multi-tenancy is enabled
- Optional headers: IHeaders
  
  HTTP request headers.
Returns Promise<IChain[]>

searchFaucets

searchFaucets(authToken?: undefined | string, headers?: IHeaders): Promise<IFaucet[]>

- Defined in src/client/OrchestrateClient.ts:251
Fetch list of registered faucets

Parameters
- Optional authToken: undefined | string
  
  Bearer token. Required when multi-tenancy is enabled
- Optional headers: IHeaders
  
  HTTP request headers.
Returns Promise<IFaucet[]>

searchTransactions

searchTransactions(searchRequest: ISearchTransactionRequest, authToken?: undefined | string, headers?: IHeaders): Promise<ITransaction[]>

- Defined in src/client/OrchestrateClient.ts:52
Search for transactions

Parameters
- searchRequest: ISearchTransactionRequest
  
  transaction search request data
- Optional authToken: undefined | string
  
  Bearer token. Required when multi-tenancy is enabled
- Optional headers: IHeaders
  
  HTTP request headers.
Returns Promise<ITransaction[]>

sendRawTransaction

sendRawTransaction(sendRawRequest: ISendRawRequest, idempotencyKey?: undefined | string, authToken?: undefined | string, headers?: IHeaders): Promise<ITransaction>

- Defined in src/client/OrchestrateClient.ts:132
Send raw transaction request

Parameters
- sendRawRequest: ISendRawRequest
  
  raw transaction request data
- Optional idempotencyKey: undefined | string
  
  Optional transaction unique identifier
- Optional authToken: undefined | string
  
  Bearer token. Required when multi-tenancy is enabled
- Optional headers: IHeaders
  
  HTTP request headers.
Returns Promise<ITransaction>

sendTransaction

sendTransaction(sendRequest: ISendTransactionRequest, idempotencyKey?: undefined | string, authToken?: undefined | string, headers?: IHeaders): Promise<ITransaction>

- Defined in src/client/OrchestrateClient.ts:105
Send contract transaction request

Parameters
- sendRequest: ISendTransactionRequest
  
  transaction request data
- Optional idempotencyKey: undefined | string
  
  Optional transaction unique identifier
- Optional authToken: undefined | string
  
  Bearer token. Required when multi-tenancy is enabled
- Optional headers: IHeaders
  
  HTTP request headers.
Returns Promise<ITransaction>

signMessage

signMessage(address: string, request: ISignMessageRequest, authToken?: undefined | string, headers?: IHeaders): Promise<string>

- Defined in src/client/OrchestrateClient.ts:451
Signs a message using a registered Ethereum account

Parameters
- address: string
  
  account's Ethereum address
- request: ISignMessageRequest
  
  sign message request
- Optional authToken: undefined | string
  
  Bearer token. Required when multi-tenancy is enabled
- Optional headers: IHeaders
  
  HTTP request headers.
Returns Promise<string>

signTypedData

signTypedData(address: string, request: ISignTypedDataRequest, authToken?: undefined | string, headers?: IHeaders): Promise<string>

- Defined in src/client/OrchestrateClient.ts:493
Signs a typed data message using a registered Ethereum account

Parameters
- address: string
  
  account's Ethereum address
- request: ISignTypedDataRequest
  
  sign typed data request
- Optional authToken: undefined | string
  
  Bearer token. Required when multi-tenancy is enabled
- Optional headers: IHeaders
  
  HTTP request headers.
Returns Promise<string>

transfer

transfer(transferRequest: ITransferRequest, idempotencyKey?: undefined | string, authToken?: undefined | string, headers?: IHeaders): Promise<ITransaction>

- Defined in src/client/OrchestrateClient.ts:159
Send transfer transaction request

Parameters
- transferRequest: ITransferRequest
  
  transfer transaction request data
- Optional idempotencyKey: undefined | string
  
  Optional transaction unique identifier
- Optional authToken: undefined | string
  
  Bearer token. Required when multi-tenancy is enabled
- Optional headers: IHeaders
  
  HTTP request headers.
Returns Promise<ITransaction>

updateAccount

updateAccount(address: string, request: IUpdateAccountRequest, authToken?: undefined | string, headers?: IHeaders): Promise<IAccount>

- Defined in src/client/OrchestrateClient.ts:472
Updates an account's information

Parameters
- address: string
  
  account's Ethereum address
- request: IUpdateAccountRequest
  
  update request data
- Optional authToken: undefined | string
  
  Bearer token. Required when multi-tenancy is enabled
- Optional headers: IHeaders
  
  HTTP request headers.
Returns Promise<IAccount>

updateChain

updateChain(chainUUID: string, chainRequest: IUpdateChainRequest, authToken?: undefined | string, headers?: IHeaders): Promise<IChain>

- Defined in src/client/OrchestrateClient.ts:219
Update a registered chain

Parameters
- chainUUID: string
  
  uuid of registered chain
- chainRequest: IUpdateChainRequest
  
  register chain request data
- Optional authToken: undefined | string
  
  Bearer token. Required when multi-tenancy is enabled
- Optional headers: IHeaders
  
  HTTP request headers.
Returns Promise<IChain>

verifyMessage

verifyMessage(request: IVerifyMessageRequest, authToken?: undefined | string, headers?: IHeaders): Promise<void>

- Defined in src/client/OrchestrateClient.ts:513
Verifies the signature of a message

Parameters
- request: IVerifyMessageRequest
  
  update request data
- Optional authToken: undefined | string
  
  Bearer token. Required when multi-tenancy is enabled
- Optional headers: IHeaders
  
  HTTP request headers.
Returns Promise<void>

verifyTypedDataSignature

verifyTypedDataSignature(request: IVerifyTypedDataSignatureRequest, authToken?: undefined | string, headers?: IHeaders): Promise<void>

- Defined in src/client/OrchestrateClient.ts:532
Verifies the signature of a typed data message

Parameters
- request: IVerifyTypedDataSignatureRequest
  
  update request data
- Optional authToken: undefined | string
  
  Bearer token. Required when multi-tenancy is enabled
- Optional headers: IHeaders
  
  HTTP request headers.
Returns Promise<void>

Generated using TypeDoc