/blockchain

Previous/auth_scheme Next/followee

Last updated 10 days ago

Gets contracts.

Gets a pagination of SmartContracts.

get

/blockchain/omni/smart_contract

Authorizations

Query parameters

offsetany · default: 0

countany · default: 20

apiundefined · enum

Options: NEO, ETHEREUM, SOLANA, FLOW, NEAR

networkany

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

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

post

/blockchain/omni/smart_contract

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.

metadataany

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"
}

Gets a specific Smart Contract

Gets a specific Smart Contract by contractId.

get

/blockchain/omni/smart_contract/{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"
}

Patches a Smart Contract

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

put

/blockchain/omni/smart_contract/{contractId}

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.

metadataany

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"
}

Deletes a Smart Contract

Deletes a Smart Contract with the specified contractId.

delete

/blockchain/omni/smart_contract/{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

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

get

/blockchain/omni/vault

Authorizations

Query parameters

offsetany · default: 0

countany · default: 20

userIdany

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"
}

Creates a new Vault

Creates a new Vault, associated with the given user.

post

/blockchain/omni/vault

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.

passphraseany

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 · enum

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"
}

Gets a specific Vault

Gets a specific Vault by Id.

get

/blockchain/omni/vault/{vaultId}

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"
}

Updates a Vault

Updates a Vault with the specified name or id.

put

/blockchain/omni/vault/{vaultId}

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.

passphraseany

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.

newPassphraseany

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"
}

Deletes a Vault

Deletes a Vault with the specified id.

delete

/blockchain/omni/vault/{vaultId}

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

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

get

/blockchain/omni/vault/{vaultId}/wallet

Authorizations

Path parameters

vaultIdanyrequired

Query parameters

offsetany · default: 0

countany · default: 20

userIdany

apiundefined · enum

Options: NEO, ETHEREUM, SOLANA, FLOW, NEAR

networkany

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"
}

Creates a new Wallet

Creates a new Wallet, associated with the given user.

post

/blockchain/omni/vault/{vaultId}/wallet

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.

preferredAccountany

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"
}

Gets a specific Wallet

Gets a specific Wallet by Id.

get

/blockchain/omni/vault/{vaultId}/wallet/{walletId}

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"
}

Updates a Wallet

Updates a Wallet with the specified name or id.

put

/blockchain/omni/vault/{vaultId}/wallet/{walletId}

Authorizations

Path parameters

vaultIdanyrequired

walletIdanyrequired

Body

displayNameany

The new display name of the wallet.

preferredAccountany · min: 1

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"
}

Deletes a Wallet

Deletes a Wallet with the specified id.

delete

/blockchain/omni/vault/{vaultId}/wallet/{walletId}

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

Gets a specific Wallet by Id.

get

/blockchain/omni/wallet/{walletId}

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"
}