-
Notifications
You must be signed in to change notification settings - Fork 28
Aptos: add shared capability payload conversion helpers #1923
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,128 @@ | ||
| package aptos | ||
|
|
||
| import ( | ||
| "fmt" | ||
| "math" | ||
|
|
||
| capaptos "github.com/smartcontractkit/chainlink-common/pkg/capabilities/v2/chain-capabilities/aptos" | ||
| typeaptos "github.com/smartcontractkit/chainlink-common/pkg/types/chains/aptos" | ||
| ) | ||
|
|
||
| // ConvertCapabilityViewPayloadFromProto converts Aptos capability proto input into the | ||
| // shared Aptos domain payload used by relayers and loop clients. | ||
| func ConvertCapabilityViewPayloadFromProto(payload *capaptos.ViewPayload) (*typeaptos.ViewPayload, error) { | ||
| if payload == nil { | ||
| return nil, fmt.Errorf("viewRequest.Payload is required") | ||
| } | ||
| if payload.Module == nil { | ||
| return nil, fmt.Errorf("viewRequest.Payload.Module is required") | ||
| } | ||
| if payload.Function == "" { | ||
| return nil, fmt.Errorf("viewRequest.Payload.Function is required") | ||
| } | ||
| if len(payload.Module.Address) > typeaptos.AccountAddressLength { | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. shouldn't the validation check exact size? |
||
| return nil, fmt.Errorf("module address too long: %d", len(payload.Module.Address)) | ||
| } | ||
|
|
||
| var moduleAddress typeaptos.AccountAddress | ||
| copy(moduleAddress[typeaptos.AccountAddressLength-len(payload.Module.Address):], payload.Module.Address) | ||
|
|
||
| argTypes := make([]typeaptos.TypeTag, 0, len(payload.ArgTypes)) | ||
| for i, tag := range payload.ArgTypes { | ||
| converted, err := ConvertCapabilityTypeTagFromProto(tag) | ||
| if err != nil { | ||
| return nil, fmt.Errorf("invalid arg type at index %d: %w", i, err) | ||
| } | ||
| argTypes = append(argTypes, *converted) | ||
| } | ||
|
|
||
| return &typeaptos.ViewPayload{ | ||
| Module: typeaptos.ModuleID{ | ||
| Address: moduleAddress, | ||
| Name: payload.Module.Name, | ||
| }, | ||
| Function: payload.Function, | ||
| ArgTypes: argTypes, | ||
| Args: payload.Args, | ||
| }, nil | ||
| } | ||
|
|
||
| // ConvertCapabilityTypeTagFromProto converts Aptos capability proto type tags into | ||
| // the shared Aptos domain type tags used by relayers and loop clients. | ||
| func ConvertCapabilityTypeTagFromProto(tag *capaptos.TypeTag) (*typeaptos.TypeTag, error) { | ||
| if tag == nil { | ||
| return nil, fmt.Errorf("type tag is nil") | ||
| } | ||
|
|
||
| var impl typeaptos.TypeTagImpl | ||
| switch tag.Kind { | ||
| case capaptos.TypeTagKind_TYPE_TAG_KIND_BOOL: | ||
| impl = typeaptos.BoolTag{} | ||
| case capaptos.TypeTagKind_TYPE_TAG_KIND_U8: | ||
| impl = typeaptos.U8Tag{} | ||
| case capaptos.TypeTagKind_TYPE_TAG_KIND_U16: | ||
| impl = typeaptos.U16Tag{} | ||
| case capaptos.TypeTagKind_TYPE_TAG_KIND_U32: | ||
| impl = typeaptos.U32Tag{} | ||
| case capaptos.TypeTagKind_TYPE_TAG_KIND_U64: | ||
| impl = typeaptos.U64Tag{} | ||
| case capaptos.TypeTagKind_TYPE_TAG_KIND_U128: | ||
| impl = typeaptos.U128Tag{} | ||
| case capaptos.TypeTagKind_TYPE_TAG_KIND_U256: | ||
| impl = typeaptos.U256Tag{} | ||
| case capaptos.TypeTagKind_TYPE_TAG_KIND_ADDRESS: | ||
| impl = typeaptos.AddressTag{} | ||
| case capaptos.TypeTagKind_TYPE_TAG_KIND_SIGNER: | ||
| impl = typeaptos.SignerTag{} | ||
| case capaptos.TypeTagKind_TYPE_TAG_KIND_VECTOR: | ||
| vector := tag.GetVector() | ||
| if vector == nil { | ||
| return nil, fmt.Errorf("vector tag missing vector value") | ||
| } | ||
| elementType, err := ConvertCapabilityTypeTagFromProto(vector.ElementType) | ||
| if err != nil { | ||
| return nil, err | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. maybe wrap this error to add additional context |
||
| } | ||
| impl = typeaptos.VectorTag{ElementType: *elementType} | ||
| case capaptos.TypeTagKind_TYPE_TAG_KIND_STRUCT: | ||
| structTag := tag.GetStruct() | ||
| if structTag == nil { | ||
| return nil, fmt.Errorf("struct tag missing struct value") | ||
| } | ||
| if len(structTag.Address) > typeaptos.AccountAddressLength { | ||
| return nil, fmt.Errorf("struct address too long: %d", len(structTag.Address)) | ||
| } | ||
|
|
||
| var structAddress typeaptos.AccountAddress | ||
| copy(structAddress[typeaptos.AccountAddressLength-len(structTag.Address):], structTag.Address) | ||
|
Comment on lines
+92
to
+97
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. this looks a bit confusing and is duplicated, lets just extract this logic similar to evm |
||
|
|
||
| typeParams := make([]typeaptos.TypeTag, 0, len(structTag.TypeParams)) | ||
| for i, tp := range structTag.TypeParams { | ||
| converted, err := ConvertCapabilityTypeTagFromProto(tp) | ||
| if err != nil { | ||
| return nil, fmt.Errorf("invalid struct type param at index %d: %w", i, err) | ||
| } | ||
| typeParams = append(typeParams, *converted) | ||
| } | ||
|
|
||
| impl = typeaptos.StructTag{ | ||
| Address: structAddress, | ||
| Module: structTag.Module, | ||
| Name: structTag.Name, | ||
| TypeParams: typeParams, | ||
| } | ||
| case capaptos.TypeTagKind_TYPE_TAG_KIND_GENERIC: | ||
| generic := tag.GetGeneric() | ||
| if generic == nil { | ||
| return nil, fmt.Errorf("generic tag missing generic value") | ||
| } | ||
| if generic.Index > math.MaxUint16 { | ||
| return nil, fmt.Errorf("generic type index out of range: %d", generic.Index) | ||
| } | ||
| impl = typeaptos.GenericTag{Index: uint16(generic.Index)} | ||
| default: | ||
| return nil, fmt.Errorf("unsupported type tag kind: %v", tag.Kind) | ||
| } | ||
|
|
||
| return &typeaptos.TypeTag{Value: impl}, nil | ||
| } | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,113 @@ | ||
| package aptos_test | ||
|
|
||
| import ( | ||
| "testing" | ||
|
|
||
| "github.com/stretchr/testify/require" | ||
|
|
||
| capaptos "github.com/smartcontractkit/chainlink-common/pkg/capabilities/v2/chain-capabilities/aptos" | ||
| conv "github.com/smartcontractkit/chainlink-common/pkg/chains/aptos" | ||
| typeaptos "github.com/smartcontractkit/chainlink-common/pkg/types/chains/aptos" | ||
| ) | ||
|
|
||
| func TestConvertCapabilityViewPayloadFromProto(t *testing.T) { | ||
| t.Run("converts nested vector struct and generic tags", func(t *testing.T) { | ||
| payload, err := conv.ConvertCapabilityViewPayloadFromProto(&capaptos.ViewPayload{ | ||
| Module: &capaptos.ModuleID{Address: []byte{0x01}, Name: "coin"}, | ||
| Function: "name", | ||
| ArgTypes: []*capaptos.TypeTag{ | ||
| { | ||
| Kind: capaptos.TypeTagKind_TYPE_TAG_KIND_VECTOR, | ||
| Value: &capaptos.TypeTag_Vector{Vector: &capaptos.VectorTag{ | ||
| ElementType: &capaptos.TypeTag{ | ||
| Kind: capaptos.TypeTagKind_TYPE_TAG_KIND_STRUCT, | ||
| Value: &capaptos.TypeTag_Struct{Struct: &capaptos.StructTag{ | ||
| Address: []byte{0x02}, | ||
| Module: "aptos_coin", | ||
| Name: "Coin", | ||
| TypeParams: []*capaptos.TypeTag{ | ||
| { | ||
| Kind: capaptos.TypeTagKind_TYPE_TAG_KIND_GENERIC, | ||
| Value: &capaptos.TypeTag_Generic{Generic: &capaptos.GenericTag{Index: 7}}, | ||
| }, | ||
| }, | ||
| }}, | ||
| }, | ||
| }}, | ||
| }, | ||
| }, | ||
| }) | ||
| require.NoError(t, err) | ||
| require.NotNil(t, payload) | ||
| require.Equal(t, "name", payload.Function) | ||
| require.Len(t, payload.ArgTypes, 1) | ||
|
|
||
| vectorTag, ok := payload.ArgTypes[0].Value.(typeaptos.VectorTag) | ||
| require.True(t, ok) | ||
| structTag, ok := vectorTag.ElementType.Value.(typeaptos.StructTag) | ||
| require.True(t, ok) | ||
| require.Equal(t, "aptos_coin", structTag.Module) | ||
| require.Equal(t, "Coin", structTag.Name) | ||
| require.Len(t, structTag.TypeParams, 1) | ||
| genericTag, ok := structTag.TypeParams[0].Value.(typeaptos.GenericTag) | ||
| require.True(t, ok) | ||
| require.EqualValues(t, 7, genericTag.Index) | ||
| }) | ||
|
|
||
| t.Run("rejects nil payload", func(t *testing.T) { | ||
| _, err := conv.ConvertCapabilityViewPayloadFromProto(nil) | ||
| require.ErrorContains(t, err, "viewRequest.Payload is required") | ||
| }) | ||
|
|
||
| t.Run("rejects nil module", func(t *testing.T) { | ||
| _, err := conv.ConvertCapabilityViewPayloadFromProto(&capaptos.ViewPayload{ | ||
| Function: "name", | ||
| }) | ||
| require.ErrorContains(t, err, "viewRequest.Payload.Module is required") | ||
| }) | ||
|
|
||
| t.Run("rejects empty function", func(t *testing.T) { | ||
| _, err := conv.ConvertCapabilityViewPayloadFromProto(&capaptos.ViewPayload{ | ||
| Module: &capaptos.ModuleID{Address: []byte{0x01}, Name: "coin"}, | ||
| }) | ||
| require.ErrorContains(t, err, "viewRequest.Payload.Function is required") | ||
| }) | ||
|
|
||
| t.Run("rejects oversized module address", func(t *testing.T) { | ||
| _, err := conv.ConvertCapabilityViewPayloadFromProto(&capaptos.ViewPayload{ | ||
| Module: &capaptos.ModuleID{Address: make([]byte, typeaptos.AccountAddressLength+1), Name: "coin"}, | ||
| Function: "name", | ||
| }) | ||
| require.ErrorContains(t, err, "module address too long") | ||
| }) | ||
| } | ||
|
|
||
| func TestConvertCapabilityTypeTagFromProto(t *testing.T) { | ||
| t.Run("rejects nil tag", func(t *testing.T) { | ||
| _, err := conv.ConvertCapabilityTypeTagFromProto(nil) | ||
| require.ErrorContains(t, err, "type tag is nil") | ||
| }) | ||
|
|
||
| t.Run("rejects unsupported kind", func(t *testing.T) { | ||
| _, err := conv.ConvertCapabilityTypeTagFromProto(&capaptos.TypeTag{Kind: capaptos.TypeTagKind(255)}) | ||
| require.ErrorContains(t, err, "unsupported type tag kind") | ||
| }) | ||
|
|
||
| t.Run("rejects oversized struct address", func(t *testing.T) { | ||
| _, err := conv.ConvertCapabilityTypeTagFromProto(&capaptos.TypeTag{ | ||
| Kind: capaptos.TypeTagKind_TYPE_TAG_KIND_STRUCT, | ||
| Value: &capaptos.TypeTag_Struct{Struct: &capaptos.StructTag{ | ||
| Address: make([]byte, typeaptos.AccountAddressLength+1), | ||
| }}, | ||
| }) | ||
| require.ErrorContains(t, err, "struct address too long") | ||
| }) | ||
|
|
||
| t.Run("rejects overflowing generic index", func(t *testing.T) { | ||
| _, err := conv.ConvertCapabilityTypeTagFromProto(&capaptos.TypeTag{ | ||
| Kind: capaptos.TypeTagKind_TYPE_TAG_KIND_GENERIC, | ||
| Value: &capaptos.TypeTag_Generic{Generic: &capaptos.GenericTag{Index: 1 << 16}}, | ||
| }) | ||
| require.ErrorContains(t, err, "generic type index out of range") | ||
| }) | ||
| } |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
should module name be validated as well?