feat: meta transactions #1097

andy-haynes · 2023-04-01T01:51:31Z

This PR implements functionality for delegate actions and meta transactions for NEP 366: Meta Transactions.

For @near-js/transactions, this adds:

new action classes and creator for DelegateAction actions
methods for constructing, signing, and encoding DelegateActions
new schema entries for DelegateAction
new classes for NEP 461 prefixes

In @near-js/accounts I've added Account methods:

signedDelegate builds and signs a delegate action
signAndSendMetaTransaction builds and signs a meta transaction derived from the delegate action

A new cookbook example in included to demonstrate the usage of the new Account methods.

…zation

changeset-bot · 2023-04-01T01:51:34Z

🦋 Changeset detected

Latest commit: 71a2472

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 6 packages

Name	Type
@near-js/transactions	Minor
@near-js/accounts	Minor
@near-js/providers	Patch
@near-js/cookbook	Patch
near-api-js	Patch
@near-js/wallet-account	Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

andy-haynes · 2023-04-01T01:59:32Z

packages/transactions/src/schema.ts

+export function encodeTransaction(transaction: Transaction | SignedTransaction) {
+    return serialize(SCHEMA, transaction);
+}
+
+/**
+ * Borsh-decode a Transaction instance from a buffer
+ * @param bytes Buffer data to be decoded
+ */
+export function decodeTransaction(bytes: Buffer) {
+    return deserialize(SCHEMA, Transaction, bytes);
+}


Initially I wanted to opportunistically refactor the Transaction and SignedTransaction classes to decouple the class definitions from SCHEMA, but ultimately decided it was too much unrelated effort for a half measure.

I opted to leave these new methods in place and use them in favor of the encode/decode class methods but they're not strictly relevant to this PR.

packages/accounts/src/account.ts

…ions to relayers

packages/accounts/src/account.ts

andy-haynes · 2023-04-03T21:34:41Z

packages/cookbook/transactions/meta-transaction-relayer.js

+}
+
+module.exports = {
+    sendNearThroughRelayer,


I created the cookbook examples from a new template from an in-review PR that supports testing snippets here. When that PR is landed I can add integration tests for these.

andy-haynes · 2023-04-10T20:32:25Z

packages/transactions/src/sign.ts

+import { Signature } from './signature';
+
+interface MessageSigner {
+    sign(message: Uint8Array): Promise<Uint8Array>;


I'm not super attached to this, it was just my way of inching away from coupling transaction signing methods and network while avoiding stepping into the current state of keystores and their 1:1 account-network mapping. Definitely open to alternatives or tweaks to this approach.

👍 Let's go with it 💖

morgsmccauley

Good job on this! Most looks good, just a couple questions around the necessity of some parts :)

morgsmccauley · 2023-04-10T23:09:09Z

.changeset/lovely-balloons-talk.md

+"@near-js/cookbook": patch
+---
+
+Add support for delegate actions and meta transactions


Suggested change

Add support for delegate actions and meta transactions

Add support for meta-transactions/delegate actions

I believe meta-transactions & delegate actions are synonymous

Interesting, I made the distinction mostly in the context of relayers:

delegate action is an action signed by the relay caller

meta transaction is a transaction signed by the relayer

I omitted the hyphen to reflect its title and usage in NEP 366

Looking at the NEP closer I see it doesn't actually refer to any thing as a "meta transaction", it's just a flow facilitated by senders and relayers. Probably clearer to omit meta transactions altogether but that kinda buries the lede 😅

packages/accounts/src/account.ts

packages/transactions/src/delegated.ts

packages/accounts/src/account.ts

morgsmccauley · 2023-04-12T20:53:44Z

sorry misclick

morgsmccauley

Good job 👏

MaximusHaximus

Nice work -- looking good. Just spotted a few things which I added comments about in-line and was thinking about some naming tweaks.

Just one thing that I noticed while looking through the PR was the DelegateAction type being local to the transactions package -- I would've expected it to be in the @near-js/types package which has a Transaction type that would need to reference all of the action types for accuracy.

I think to avoid circular references between the types package and the rest of the packages we're going to need to pull almost all of the types into the types package and only keep internal/local types in the individual packages that use the @near-js/types package -- I think this is why a Transaction type exists in the types package, but because Action types don't, the Transaction type in the types package defines actions as an type. We should have a chat about this and it's not any kind of a blocker for this PR to land for us to iterate on.

MaximusHaximus · 2023-04-13T12:01:11Z

packages/transactions/src/delegate.ts

+    DeleteAccount,
+} from './actions.js';
+
+export type NonDelegateAction =


Naming feels a bit counter-intuitive -- could this be DelegableAction instead to make it more explicit and to describe what it is rather than what it isn't? It's less likely to change if for some reason we introduce new actions in the future that have a similar restriction (cannot be delegated) even though right now the only action that can't be delegated is a DelegateAction. Could add a JSDoc on the type to describe how DelegateActions are not delegable if we want to call attention to that specifically

Looking at it more closely I see it's actually ignoring the union types altogether:

{ actions: Array<AddKey> } => actions = [new SignedDelegate({})] ❌

{ actions: Array<AddKey | DeleteKey> } => actions = [new SignedDelegate({})] ✅

It looks like by having a union with > 1 members, the common shape is demoted to their common Assignable base class and so anything with constructor(properties: any) will pass the union. This wasn't something I knew about union types 💡

So with the current implementation being set dressing, I think options are:

double down on this approach and incorporate delegability into the class hierarchy

implement the chain-side logic in the client with runtime checks that throw exceptions when a non-delegate action is added to the signed delegate

ignore for now and let the chain fail them

Let's let the chain fail them and re-visit the classes later for ideal typesafety 👍

packages/transactions/src/delegate.ts

packages/transactions/src/actions.ts

packages/transactions/src/delegate.ts

packages/transactions/src/prefix.ts

packages/transactions/src/schema.ts

packages/transactions/src/sign.ts

packages/accounts/src/account.ts

MaximusHaximus · 2023-04-13T12:35:24Z

packages/transactions/src/sign.ts

+import { Signature } from './signature';
+
+interface MessageSigner {
+    sign(message: Uint8Array): Promise<Uint8Array>;


👍 Let's go with it 💖

Co-authored-by: Daryl Collins <daryl@darylcollins.com>

andy-haynes · 2023-04-13T18:08:16Z

we're going to need to pull almost all of the types into the types package and only keep internal/local types in the individual packages that use the @near-js/types package

The crux of the issue is that many of these are classes implementing methods with heavy dependencies not appropriate for @near-js/types. Transaction is a good example but PublicKey is even better. To do it cleanly requires another substantial refactor with breaking changes.

I think this is why a Transaction type exists in the types package, but because Action types don't, the Transaction type in the types package defines actions as an type.

The Transaction type in @near-js/types is a duplicate definition that originally came from the providers.ts file before the refactor. They should be merged when appropriate.

MaximusHaximus

👍 I think this is shippable at this stage 💖

andy-haynes added 10 commits March 31, 2023 16:49

feat: decouple Transaction and SignedTransaction classes from seriali…

0232b44

…zation

feat: move Signature to separate module

8898fea

feat: class for DelegateAction

8ccd7ef

feat: action for SignedDelegate

24b706e

feat: serialization for delegate action classes

d5b804c

feat: message prefix logic from NEP-461

73f482b

feat: method for delegate action signing

01b8f95

feat: method for building delegate actions

690e7fc

feat: module for building meta transactions

24830e1

feat: method for delegate action signing

07dd0c7

andy-haynes added 5 commits March 31, 2023 18:52

feat: account methods for signing delegate actions and meta transactions

d87fdf0

docs: cookbook for meta transactions

e15a336

fix: lint

54b8222

feat: hold off on breaking change in @near-js/transactions

72f67dd

ci: changeset

d97d2a6

andy-haynes force-pushed the feat/meta-transactions branch from f2e5094 to d97d2a6 Compare April 1, 2023 01:52

andy-haynes commented Apr 1, 2023

View reviewed changes

andy-haynes changed the title ~~Feat/meta transactions~~ feat: meta transactions Apr 1, 2023

andy-haynes commented Apr 3, 2023

View reviewed changes

packages/accounts/src/account.ts Outdated Show resolved Hide resolved

andy-haynes added 2 commits April 3, 2023 14:29

feat: account methods for serializing and sending signed delegate act…

81802a5

…ions to relayers

feat: cookbook example for working with relayer

47509fd

andy-haynes force-pushed the feat/meta-transactions branch from 65c0642 to 47509fd Compare April 3, 2023 21:29

andy-haynes commented Apr 3, 2023

View reviewed changes

packages/accounts/src/account.ts Outdated Show resolved Hide resolved

andy-haynes commented Apr 3, 2023

View reviewed changes

Merge branch 'master' into feat/meta-transactions

8a5ae48

andy-haynes commented Apr 10, 2023

View reviewed changes

andy-haynes requested a review from morgsmccauley April 10, 2023 23:50

cif mentioned this pull request Apr 12, 2023

test(testing): ⚗️ Seed phrase and zero balance account Mintbase/mintbase-js#338

Closed

morgsmccauley reviewed Apr 12, 2023

View reviewed changes

morgsmccauley closed this Apr 12, 2023

morgsmccauley reopened this Apr 12, 2023

andy-haynes and others added 5 commits April 12, 2023 14:53

feat: remove wrapper method

4e2f313

feat: delegated -> delegate

1bb3d43

feat: leave relayer calls to implementer

e2c79ec

feat: remove default value

5818fda

Merge branch 'master' into feat/meta-transactions

31cca02

andy-haynes requested a review from morgsmccauley April 12, 2023 22:18

andy-haynes and others added 2 commits April 12, 2023 15:18

Merge branch 'master' into feat/meta-transactions

3059c91

feat: remove unused module

e803ef6

morgsmccauley previously approved these changes Apr 13, 2023

View reviewed changes

MaximusHaximus suggested changes Apr 13, 2023

View reviewed changes

Update packages/transactions/src/schema.ts

26c03b9

Co-authored-by: Daryl Collins <daryl@darylcollins.com>

andy-haynes dismissed morgsmccauley’s stale review via 26c03b9 April 13, 2023 16:55

andy-haynes added 3 commits April 13, 2023 11:39

fix: drop extension

55a70c3

feat: inline nonce

f5d6b58

fix: missing blockHeightTtl in cookbook

c012f77

andy-haynes requested a review from MaximusHaximus April 13, 2023 18:40

andy-haynes added 2 commits April 13, 2023 12:26

fix: block height data type

100095b

fix: remove unenforced type constraint

71a2472

MaximusHaximus approved these changes Apr 13, 2023

View reviewed changes

andy-haynes merged commit 273d678 into master Apr 13, 2023

andy-haynes deleted the feat/meta-transactions branch April 13, 2023 22:06

github-actions bot mentioned this pull request Apr 13, 2023

Publish packages #1101

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: meta transactions #1097

feat: meta transactions #1097

andy-haynes commented Apr 1, 2023

changeset-bot bot commented Apr 1, 2023 •

edited

Loading

andy-haynes Apr 1, 2023 •

edited

Loading

andy-haynes Apr 3, 2023

andy-haynes Apr 10, 2023

MaximusHaximus Apr 13, 2023

morgsmccauley left a comment

morgsmccauley Apr 10, 2023

andy-haynes Apr 12, 2023

andy-haynes Apr 12, 2023

morgsmccauley commented Apr 12, 2023

morgsmccauley left a comment

MaximusHaximus left a comment

MaximusHaximus Apr 13, 2023

andy-haynes Apr 13, 2023

MaximusHaximus Apr 13, 2023

MaximusHaximus Apr 13, 2023

andy-haynes commented Apr 13, 2023

MaximusHaximus left a comment

	Add support for delegate actions and meta transactions
	Add support for meta-transactions/delegate actions

feat: meta transactions #1097

feat: meta transactions #1097

Conversation

andy-haynes commented Apr 1, 2023

changeset-bot bot commented Apr 1, 2023 • edited Loading

🦋 Changeset detected

andy-haynes Apr 1, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

morgsmccauley left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

morgsmccauley commented Apr 12, 2023

morgsmccauley left a comment

Choose a reason for hiding this comment

MaximusHaximus left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

andy-haynes commented Apr 13, 2023

MaximusHaximus left a comment

Choose a reason for hiding this comment

changeset-bot bot commented Apr 1, 2023 •

edited

Loading

andy-haynes Apr 1, 2023 •

edited

Loading