Deposit Token Deployment Reference
The following information includes descriptions of the database objects that are created by the ORDS script, and troubleshooting tips.
The ORDS script creates the following operational views using the configured VIEW_PREFIX parameter.
<VIEW_PREFIX>_ACCOUNTS_V
<VIEW_PREFIX>_TRANSFER_EVENTS_V
<VIEW_PREFIX>_HOLDS_V
<VIEW_PREFIX>_ACTIVE_ROLES_V
<VIEW_PREFIX>_ACCOUNT_TX_HISTORY_V
<VIEW_PREFIX>_ACCOUNT_HISTORY_VIf you select analytics, the following analytics views are created, scoped to the deployment.
<VIEW_PREFIX>_ACCOUNTS_MOD
<VIEW_PREFIX>_TRANSACTION_MOD
<VIEW_PREFIX>_ACCOUNTS_TRANSACTION_MODThe script also creates or configures the ORDS module, routes, schema alias, role, privilege, OAuth client, and client-role association using the configured values.
View Catalog and Query Logic
The following views are ordinary Oracle views in the selected schema; they do not modify the extractor tables.
| View | Primary Source | Purpose/Logic |
|---|---|---|
<VIEW_PREFIX>_ACCOUNTS_V |
_more, _store_state |
Builds the current account directory from createAccount calls and account/token state. It resolves account, user and organization identity, balances, hold balances, status, daily limits, token metadata, and creation transaction metadata.
|
<VIEW_PREFIX>_TRANSFER_EVENTS_V |
_more |
Normalizes token receipt logs into transfer-event rows. It extracts sender, receiver, amount, function, block/transaction metadata, and optional ~OBPRPCTX~.value.category context.
|
<VIEW_PREFIX>_HOLDS_V |
_store_hist, _more, _store_state |
Reconstructs mint, burn, and transfer-hold records. It extracts operation/holding ID, accounts, notary, amount, expiry, token, category, description, and the latest lifecycle status. It also provides fallback rows when a current state row is not resolvable. |
<VIEW_PREFIX>_ACTIVE_ROLES_V |
_more |
Applies role add/remove history and returns the latest active role assignment per account and role. |
<VIEW_PREFIX>_ACCOUNT_TX_HISTORY_V |
The preceding operational views | Produces account-facing transaction-history rows, including both sides of transfers and normalized mint/burn/hold lifecycle outcomes. It enriches from/to identities from the _ACCOUNTS_V view.
|
<VIEW_PREFIX>_ACCOUNT_HISTORY_V |
_more, _ACCOUNTS_V |
Produces account configuration history from account contract mutations, including daily limit revisions, timestamps, block numbers, and transaction IDs. |
<VIEW_PREFIX>_ACCOUNTS_MOD (optional analytics)
|
_ACCOUNTS_V |
Exposes account metadata in the analytics-compatible account shape. |
<VIEW_PREFIX>_TRANSACTION_MOD (optional analytics)
|
_TRANSFER_EVENTS_V, _HOLDS_V, _store_hist |
Exposes normalized business transactions, including transfer, mint, burn, request, hold, release, and resulting balances where available. |
<VIEW_PREFIX>_ACCOUNTS_TRANSACTION_MOD (optional analytics)
|
_TRANSACTION_MOD, _ACCOUNTS_V |
Adds source and destination organization context to analytics transaction records. |
ORDS Routes
All routes are GET routes under <BASE_PATH>/ and require an OAuth bearer token. ORDS returns a collection envelope; an empty items array with HTTP 200 means that the request was valid but had no matching indexed records.
| Route | Use and Response Behavior | Required Inputs | Optional Inputs and Default Behavior |
|---|---|---|---|
getDepositTokenTransactionById |
Returns one normalized ledger-transaction detail record. | token_id identifies the token; transaction_id identifies the Besu transaction.
|
None. No match returns an empty collection. |
getDepositTokenAccountTransactionHistory |
Returns history for the account resolved by business identity. | token_id, org_id, and user_id identify the account.
|
startTime and endTime restrict the time range; omit either for no boundary. bookmark defaults to 0. pageSize uses the handler default.
|
getAllDepositTokenAccountTransactionHistory |
Returns token-wide account transaction history. | token_id identifies the token.
|
startTime, endTime, bookmark, and pageSize behave as for the account-specific history route.
|
getDepositTokenAccountStatusHistory |
Returns indexed status-history rows for a business account. | token_id, org_id, and user_id identify the account.
|
None. |
getDepositTokenApproverActionHistory |
Returns manager/approver decisions and final transfer-hold actions. | token_id identifies the token.
|
caller_account_id is the actor wallet; omit for all actors or provide it to scope to one wallet.
|
getDepositTokenHistory |
Returns token-level history and supply-related information. | token_id identifies the token.
|
None. |
getDepositTokenAccountsByRole |
Returns accounts associated with a role. | role is the role name to match.
|
None. |
getDepositTokenUsersByRole |
Returns user/account role assignments for a role. | role is the role name to match.
|
None. |
getDepositTokenOrganizationAccountsByRole |
Returns organization accounts that have a role | org_id identifies the organization; role is the role name.
|
None. |
getAllDepositTokenAccounts |
Returns all indexed accounts for one token. | token_id identifies the token.
|
None. |
getAllActiveDepositTokenAccounts |
Returns accounts whose current indexed status is active. | token_id identifies the token.
|
None. |
getAllSuspendedDepositTokenAccounts |
Returns accounts whose current indexed status is suspended. | token_id identifies the token.
|
None. |
getDepositTokenOrganizationAccounts |
Returns all indexed accounts in one organization. | org_id identifies the organization.
|
None. |
getPendingDepositTokenIssuance |
Returns current pending transfer-hold operations only. | token_id identifies the token.
|
caller_account_id is the notary/manager wallet. Omit for the full queue; provide to scope to that wallet. Terminal operations are excluded.
|
getPendingDepositTokenRequest |
Returns pending mint/burn/transfer requests only. | token_id identifies the token; request_type selects the supported request type.
|
None. Only operations whose latest lifecycle event remains pending are returned. |
getPendingRequest |
Compatibility pending-request route. | token_id and request_type have the same meaning as getPendingDepositTokenRequest |
None. |
getDepositTokenAccountsByUser |
Returns account records for one organization/user/token combination. | token_id, org_id, and user_id identify the account owner and token.
|
None. |
getDepositTokenAccountHistory |
Returns account configuration/history revisions. | account_address is the blockchain account/wallet address.
|
offset is a zero-based offset; limit caps rows. Omit either for the handler default.
|
getDepositTokenAccountStatus |
Returns the current indexed account status. | token_id, org_id, and user_id identify the account.
|
None. |
getDepositTokenRolesByAccount |
Returns roles for a resolved account. | token_id is always required. Supply either account_address or org_id and user_id.
|
If account_address is supplied it is the direct lookup; otherwise organization/user lookup is used.
|
getAllDepositTokenOrganizations |
Returns organizations represented by indexed accounts for a token. | token_id identifies the token.
|
None. |
getDepositTokenMetadata |
Returns indexed immutable token metadata. | token_id identifies the token.
|
None. |
getDepositTokenRetiredQuantity |
Returns retired/burned quantity information for a token. | token_id identifies the token.
|
None. |
getDepositTokenAccountPolicies |
Returns current account-policy records. | None. | account_policy_id selects one policy; account_address filters by account. Omit both to list all. bookmark defaults to 0; pageSize defaults to 20.
|
getDepositTokenAccountPolicyHistory |
Returns account-policy revisions. | None. | account_policy_id and account_address filter revisions; omit both to list all. bookmark defaults to 0; pageSize defaults to 20.
|
getDepositTokenApprovalPolicies |
Returns current approval-policy records. | None. | approval_policy_id selects one policy; omit it to list all. bookmark defaults to 0; pageSize defaults to 20.
|
getDepositTokenApprovalPolicyHistory |
Returns approval-policy revisions. | None. | approval_policy_id filters revisions; omit it to list all. bookmark defaults to 0; pageSize defaults to 20.
|
getPendingDepositTokenApprovalOperations |
Returns current operations awaiting approval. | None. | token_id and operation_id are optional filters. Omit operation_id to list all current pending operations. bookmark defaults to 0; pageSize defaults to 20.
|
getDepositTokenApprovalsByApprover |
Returns approval/rejection decisions by an approver. | approver_address is the approver wallet address.
|
operation_id narrows results to one operation; omit for all decisions by that approver. bookmark defaults to 0; pageSize defaults to 20.
|
getDepositTokenApprovalsByOperationId |
Returns approval/rejection events for one operation. | operation_id identifies the approval operation.
|
bookmark defaults to 0; pageSize defaults to 20.
|
getDepositTokenApprovalStatusByOperationId |
Returns stored workflow status plus current active-policy resolution. | token_id and operation_id identify the workflow/hold.
|
None. It does not generate synthetic BLOCKED or AWAITING_MANAGER_COMPLETION statuses.
|
Pagination and timestamps: The bookmark parameter is a zero-based row offset and the pageSize parameter is case-sensitive camel case. For history routes, startTime and endTime use ISO-8601 timestamp text in the format YYYY-MM-DDTHH:MI:SS+/-HH:MI.
Endpoint inventory: The exact route inventory belongs to the script version packaged for the deployment. After the run, use the ORDS OpenAPI catalog or the generated endpoint output as the authoritative list for the client application.
Troubleshooting
| Message or Condition | Resolution |
|---|---|
NJS-516: no configuration directory set |
A TNS alias was used without an accessible wallet/configuration directory. Extract the wallet and configure the Oracle client so that the tnsnames.ora file is available.
|
NJS-511 or ORA-12506 |
Listener, endpoint, service name, network allowlist, or wallet configuration issue. Validate the Oracle connection outside the script with the DBA. |
| OAuth token request returns 404 | Verify the exact alias in /ords/<ALIAS_NAME>/oauth/token. The alias is not necessarily the Oracle username.
|
| Endpoint returns 401 | Obtain a fresh token and verify the OAuth client has the role/privilege associated with the configured module base path. |
| Endpoint returns 404 | Verify host, alias, base path, route name, and that the module is published. |
ORDS-25001 |
The endpoint reached ORDS but its SQL failed. Verify the table prefix, contract addresses, source data shape, and required request parameters. |
ORA-20049: Cannot alter the URL mapping while the schema is enabled |
The chosen ALIAS_NAME conflicts with an enabled schema mapping. Reuse the schema's existing alias, or have the ORDS administrator complete the approved disable/remap/enable procedure before running the script again.
|
| Views contain no rows | Confirm the correct rich history profile was selected during instance creation, the table prefix is exact, contract addresses match the deployed proxies, and transactions have been indexed. |
| Objects conflict with another deployment | Use a distinct VIEW_PREFIX, module name, base path, role, privilege, OAuth client name, and alias.
|