Implement account.viewState which allows querying contract state directly #452
Conversation
vgrichina
changed the title
| const { values } = await this.connection.provider.query({ | ||
| request_type: 'view_state', | ||
| block_id: blockId, | ||
| finality: blockId ? undefined : finality || 'optimistic', |
There was a problem hiding this comment.
There's a pretty tricky interplay between blockId & finality here that I'd like to see documented more explicitly. Can we add a code comment above viewState to get picked up by typedoc, as well as throwing an error message when you pass a nonsensical combination of the two?
There was a problem hiding this comment.
yeah, I forgot about the doc here, will add
There was a problem hiding this comment.
as well as throwing an error message when you pass a nonsensical combination of the two?
Types kinda describe it. We aren't really checking types during runtime in most other places. TBH this is something I really don't understand about TypeScript. Like doing this whole effort with types and then not having easy way to check in runtime automatically 🤷♂️
There was a problem hiding this comment.
created issue to track #457
src/account.ts
Outdated
| block_id: blockId, | ||
| finality: blockId ? undefined : finality || 'optimistic', | ||
| account_id: this.accountId, | ||
| prefix_base64: Buffer.from(prefix,).toString('base64') |
There was a problem hiding this comment.
What's with the comma in (prefix,)?
src/account.ts
Outdated
| prefix_base64: Buffer.from(prefix,).toString('base64') | ||
| }); | ||
|
|
||
| return values.map(({key, value}) => ({ key: Buffer.from(key, 'base64'), value: Buffer.from(value, 'base64')})) |
There was a problem hiding this comment.
Please break up this long line
| @@ -68,13 +68,17 @@ export class JsonRpcProvider extends Provider { | |||
|
|
|||
| /** | |||
| * Query the RPC as [shown in the docs](https://docs.nearprotocol.com/docs/interaction/rpc#query) | |||
| * @param path Path parameter for the RPC (ex. "contract/my_token") | |||
| * @param data Data parameter (ex. "", "AQ4", or whatever is needed) | |||
There was a problem hiding this comment.
Please add documentation to describe the new interface & behavior
There was a problem hiding this comment.
@chadoh what inft do you think is going to be useful outside of link to corresponding RPC docs?
If I added a doc in style of the docs we had before it would be something like:
@param params parameters for the RPC
which I don't think is adding value
| @@ -241,6 +242,7 @@ export abstract class Provider { | |||
|
|
|||
| abstract async sendTransaction(signedTransaction: SignedTransaction): Promise<FinalExecutionOutcome>; | |||
| abstract async txStatus(txHash: Uint8Array, accountId: string): Promise<FinalExecutionOutcome>; | |||
| abstract async query(params: object): Promise<any>; | |||
| abstract async query(path: string, data: string): Promise<any>; | |||
There was a problem hiding this comment.
Do we want to have both versions of query here?
There was a problem hiding this comment.
Yes to avoid breaking backwards compatibility
src/providers/provider.ts
Outdated
| @@ -26,6 +26,7 @@ type BlockHash = string; | |||
| type BlockHeight = number; | |||
| export type BlockId = BlockHash | BlockHeight; | |||
|
|
|||
| // TODO: Remove near-final? | |||
There was a problem hiding this comment.
near-final used to be in the docs, but I don't see it anymore. Maybe this was removed. Who can we ask?
Seems like we could make a separate PR that just removes this option, and request review from people who would know enough to approve or reject the change.
There was a problem hiding this comment.
No idea, that's why I just added TODO
There was a problem hiding this comment.
Seems like this is secret feature 🤷♂️
|
Added docs and tests, etc @chadoh |
No description provided.