/blockchain

Previous/oidc Next/followee

Last updated 18 days ago

Gets a specific Smart Contract

get

Gets a specific Smart Contract by contractId.

Authorizations

Path parameters

contractIdanyrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'http://localhost:8080/api/rest/blockchain/omni/smart_contract/{contractId}' \
  --header 'Authorization: YOUR_API_KEY'

400

401

403

404

409

500

501

503

default

{
  "code": "text",
  "message": "text"
}

Deletes a Smart Contract

delete

Deletes a Smart Contract with the specified contractId.

Authorizations

Path parameters

contractIdanyrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'http://localhost:8080/api/rest/blockchain/omni/smart_contract/{contractId}' \
  --header 'Authorization: YOUR_API_KEY'

400

401

403

404

409

500

501

503

default

{
  "code": "text",
  "message": "text"
}

Gets vaults. Optionally filtered for a specific user

get

Gets a pagination of Wallets. Optionally a user Id can be specified to filter for a given user.

Authorizations

Query parameters

offsetany · default: 0optional

countany · default: 20optional

userIdanyoptional

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'http://localhost:8080/api/rest/blockchain/omni/vault' \
  --header 'Authorization: YOUR_API_KEY'

400

401

403

404

409

500

501

503

default

{
  "code": "text",
  "message": "text"
}

Gets a specific Vault

get

Gets a specific Vault by Id.

Authorizations

Path parameters

vaultIdanyrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'http://localhost:8080/api/rest/blockchain/omni/vault/{vaultId}' \
  --header 'Authorization: YOUR_API_KEY'

400

401

403

404

409

500

501

503

default

{
  "code": "text",
  "message": "text"
}

Deletes a Vault

delete

Deletes a Vault with the specified id.

Authorizations

Path parameters

vaultIdanyrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'http://localhost:8080/api/rest/blockchain/omni/vault/{vaultId}' \
  --header 'Authorization: YOUR_API_KEY'

400

401

403

404

409

500

501

503

default

{
  "code": "text",
  "message": "text"
}

Gets wallets. Optionally filtered for a specific user

get

Gets a pagination of Wallets. Optionally a user Id can be specified to filter for a given user.

Authorizations

Path parameters

vaultIdanyrequired

Query parameters

offsetany · default: 0optional

countany · default: 20optional

userIdanyoptional

apiundefined · enumoptional

Options: NEO, ETHEREUM, SOLANA, FLOW, NEAR

networkanyoptional

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'http://localhost:8080/api/rest/blockchain/omni/vault/{vaultId}/wallet' \
  --header 'Authorization: YOUR_API_KEY'

400

401

403

404

409

500

501

503

default

{
  "code": "text",
  "message": "text"
}

Gets a specific Wallet

get

Gets a specific Wallet by Id.

Authorizations

Path parameters

vaultIdanyrequired

walletIdanyrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'http://localhost:8080/api/rest/blockchain/omni/vault/{vaultId}/wallet/{walletId}' \
  --header 'Authorization: YOUR_API_KEY'

400

401

403

404

409

500

501

503

default

{
  "code": "text",
  "message": "text"
}

Deletes a Wallet

delete

Deletes a Wallet with the specified id.

Authorizations

Path parameters

vaultIdanyrequired

walletIdanyrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'http://localhost:8080/api/rest/blockchain/omni/vault/{vaultId}/wallet/{walletId}' \
  --header 'Authorization: YOUR_API_KEY'

400

401

403

404

409

500

501

503

default

{
  "code": "text",
  "message": "text"
}

Gets a specific Wallet

get

Gets a specific Wallet by Id.

Authorizations

Path parameters

walletIdanyrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'http://localhost:8080/api/rest/blockchain/omni/wallet/{walletId}' \
  --header 'Authorization: YOUR_API_KEY'

400

401

403

404

409

500

501

503

default

{
  "code": "text",
  "message": "text"
}

Gets contracts.

get

Gets a pagination of SmartContracts.

Authorizations

Query parameters

offsetany · default: 0optional

countany · default: 20optional

apiundefined · enumoptional

Options: NEO, ETHEREUM, SOLANA, FLOW, NEAR

networkanyoptional

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'http://localhost:8080/api/rest/blockchain/omni/smart_contract' \
  --header 'Authorization: YOUR_API_KEY'

400

401

403

404

409

500

501

503

default

{
  "code": "text",
  "message": "text"
}

Patches a Smart Contract

post

Patches a Smart Contract entry, associated with the specified deployed script hash.

Authorizations

Body

nameanyrequired

The unique symbolic name of the smart contract.

Pattern: ^\S+$

displayNameanyrequired

The name given to this contract for display purposes.

addressesanyrequired

The address of the contract from the blockchain. Depending on the network or protocol this may have several meanings and vary depending on the specific API or network.

vaultIdanyrequired

The Elements database id of the wallet containing the default account to be used for contract related requests.

metadataanyoptional

Any metadata for this contract.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'http://localhost:8080/api/rest/blockchain/omni/smart_contract' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: */*' \
  --data '{
    "name": null,
    "displayName": null,
    "addresses": null,
    "vaultId": null,
    "metadata": null
  }'

400

401

403

404

409

500

501

503

default

{
  "code": "text",
  "message": "text"
}

Patches a Smart Contract

put

Patches a Smart Contract entry, associated with the specified deployed script hash.

Authorizations

Path parameters

contractIdanyrequired

Body

nameanyrequired

The unique symbolic name of the smart contract.

Pattern: ^\S+$

displayNameanyrequired

The name given to this contract for display purposes.

addressesanyrequired

The address of the contract from the blockchain. Depending on the network or protocol this may have several meanings and vary depending on the specific API or network.

vaultIdanyrequired

The Elements database id of the wallet containing the default account to be used for contract related requests.

metadataanyoptional

Any metadata for this contract.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url 'http://localhost:8080/api/rest/blockchain/omni/smart_contract/{contractId}' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: */*' \
  --data '{
    "name": null,
    "displayName": null,
    "addresses": null,
    "vaultId": null,
    "metadata": null
  }'

400

401

403

404

409

500

501

503

default

{
  "code": "text",
  "message": "text"
}

Creates a new Vault

post

Creates a new Vault, associated with the given user.

Authorizations

Body

userIdanyrequired

The elements-defined user ID to own the vault.

displayNameanyrequired

A user-defined name for the vault. This is used simply for the user's reference and has no bearing onthe vault's functionality.

passphraseanyoptional

The passphrase used to to encrypt the vault. If empty, then the vault will not be encrypted. Some configurations may opt to disallow encryption entirely.

algorithmundefined · enumoptional

The encryption algorithm used to secure the vault. Once crated, a vault will contains a private/public key pair which will be used to encrypt the wallets within the vault.

Options: RSA_256, RSA_384, RSA_512

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'http://localhost:8080/api/rest/blockchain/omni/vault' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "userId": null,
    "displayName": null,
    "passphrase": null,
    "algorithm": "RSA_256"
  }'

400

401

403

404

409

500

501

503

default

{
  "code": "text",
  "message": "text"
}

Updates a Vault

put

Updates a Vault with the specified name or id.

Authorizations

Path parameters

vaultIdanyrequired

Body

displayNameanyrequired

A user-defined name for the vault. This is used simply for the user's reference and has no bearing onthe vault's functionality.

userIdanyrequired

The elements-defined user ID to own the vault.

passphraseanyoptional

The current passphrase for the vault. If left null, no updates to the passphrase will be made. If not-null, then the new password must also not be null.

newPassphraseanyoptional

The updated passphrase for the vault. If left null, no updates to the passphrase will be made. If not-null, then the password must also not be null.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url 'http://localhost:8080/api/rest/blockchain/omni/vault/{vaultId}' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: */*' \
  --data '{
    "displayName": null,
    "userId": null,
    "passphrase": null,
    "newPassphrase": null
  }'

400

401

403

404

409

500

501

503

default

{
  "code": "text",
  "message": "text"
}

Creates a new Wallet

post

Creates a new Wallet, associated with the given user.

Authorizations

Path parameters

vaultIdanyrequired

Body

displayNameanyrequired

A user-defined name for the wallet. This is used simply for the user's reference and has no bearing onthe wallet's functionality.

apiundefined · enumrequired

The protocol of this wallet. Once set, this cannot be unset.

Options: NEO, ETHEREUM, SOLANA, FLOW, NEAR

networksanyrequired

The networks associated with this wallet. All must support the Wallet's protocol.

preferredAccountanyoptional

The default identity. Must not be larger than the count of identities.

accountsanyrequired

Specifies a Custodial Wallet Account Creating a Wallet

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'http://localhost:8080/api/rest/blockchain/omni/vault/{vaultId}/wallet' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "displayName": null,
    "api": "NEO",
    "networks": [],
    "preferredAccount": null,
    "accounts": [
      {
        "generate": null,
        "address": null,
        "privateKey": null
      }
    ]
  }'

400

401

403

404

409

500

501

503

default

{
  "code": "text",
  "message": "text"
}

Updates a Wallet

put

Updates a Wallet with the specified name or id.

Authorizations

Path parameters

vaultIdanyrequired

walletIdanyrequired

Body

displayNameanyoptional

The new display name of the wallet.

preferredAccountany · min: 1optional

The default identity. Must not be larger than the count of identities.

networksanyrequired

The networks associated with this wallet. All must support the Wallet's protocol.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url 'http://localhost:8080/api/rest/blockchain/omni/vault/{vaultId}/wallet/{walletId}' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "displayName": null,
    "preferredAccount": null,
    "networks": []
  }'

400

401

403

404

409

500

501

503

default

{
  "code": "text",
  "message": "text"
}