Skip to content

Commit

Permalink
docs: update keystore README
Browse files Browse the repository at this point in the history
  • Loading branch information
rygine committed Feb 26, 2024
1 parent f6a4a2f commit c61360a
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion src/keystore/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,5 +84,5 @@ You will then want to sequence the release as follows:

1. Update the files in the `keystore` folder in a backwards-compatible way, but do not make any changes outside of the Keystore folder. Merge to `main` to create a new release of `@xmtp/xmtp-js`. If you are introducing a new method, make sure to update [`rpcDefinitions.ts`](./rpcDefinitions.ts).
2. Upgrade the `xmtp-js` dependency in `@xmtp/snap` to the newly released version. Usually this will require no other code changes, since the Snap itself is a very thin wrapper around the `InMemoryKeystore` and `rpcDefinitions`. Merge to main to create a new release of `@xmtp/snap`.
3. Run `npm run updateSnapVersion` in the root of `xmtp-js` to update the version stored in `snapInfo.json`.
3. Run `yarn updateSnapVersion` in the root of `xmtp-js` to update the version stored in `snapInfo.json`.
4. Make any changes required in the SDK to use your new Keystore method. For example, you may need to update some code to call your new API. Merge to main to create a new release.

0 comments on commit c61360a

Please sign in to comment.