Skip to content

Commit

Permalink
fixes to rpc server links, types, etc.
Browse files Browse the repository at this point in the history
  • Loading branch information
ElliotFriend committed Jun 4, 2024
1 parent a42c08e commit e2707c4
Show file tree
Hide file tree
Showing 4 changed files with 129 additions and 93 deletions.
13 changes: 13 additions & 0 deletions src/rpc/api.ts
Original file line number Diff line number Diff line change
Expand Up @@ -361,3 +361,16 @@ export namespace Api {
stateChanges?: RawLedgerEntryChange[];
}
}

/**
* @namespace Api
* @memberof module:rpc
*/

/**
* @typedef {Object} EventFilter
* @property {('contract' | 'system' | 'diagnostic')} [type] Type of contract event that must match in order for the event to pass through the filter.
* @property {Array.<string>} [contractIds] Contract addresses (`C...`) that must match in order for the event to pass through the filter.
* @property {Array.<Array<string>>} [topics] Array of topics arrays that must match in order for the event to pass through the filter.
* @memberof module:rpc.Api
*/
2 changes: 2 additions & 0 deletions src/rpc/parsers.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ import { Api } from './api';
/**
* Parse the response from invoking the `submitTransaction` method of a Soroban RPC server.
* @memberof module:rpc
* @private
*
* @param {Api.RawSendTransactionResponse} raw the raw `submitTransaction` response from the Soroban RPC server to parse
* @returns {Api.SendTransactionResponse} transaction response parsed from the Soroban RPC server's response
Expand Down Expand Up @@ -63,6 +64,7 @@ export function parseRawEvents(
/**
* Parse and return the retrieved ledger entries, if any, from a raw response from a Soroban RPC server.
* @memberof module:rpc
* @private
*
* @param {Api.RawGetLedgerEntriesResponse} raw he raw `getLedgerEntries` response from the Soroban RPC server to parse
* @returns {Api.GetLedgerEntriesResponse} ledger entries parsed from the Soroban RPC server's response
Expand Down
Loading

0 comments on commit e2707c4

Please sign in to comment.