From ed047bbde0afa41028a704d53aac6266dbba2093 Mon Sep 17 00:00:00 2001 From: Eugene Zagidullin Date: Wed, 13 Mar 2024 20:37:53 +0200 Subject: [PATCH] License and READMEs --- LICENSE | 191 +++++++++++++++++++++++++++++++++++++++++++++ README.md | 15 ++++ client/client.go | 1 + crypt/common.go | 1 + encoding/common.go | 1 + teztool/README.md | 75 ++++++++++++++++++ teztool/teztool.go | 5 ++ 7 files changed, 289 insertions(+) create mode 100644 LICENSE create mode 100644 README.md create mode 100644 teztool/README.md diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..5acd943 --- /dev/null +++ b/LICENSE @@ -0,0 +1,191 @@ + + Apache License + Version 2.0, January 2004 + https://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + Copyright 2018-2022 ECAD Labs Inc. + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + https://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/README.md b/README.md new file mode 100644 index 0000000..451e753 --- /dev/null +++ b/README.md @@ -0,0 +1,15 @@ +# gotez + +Gotez is a support module focused on Tezos binary protocol. + +## Contents + +| Package | Description | +|---------|-------------| +| `github.com/ecadlabs/gotez/v2` | Tezos primitives | +| `github.com/ecadlabs/gotez/v2/b58` | Base58 encoding for Tezos primitives | +| `github.com/ecadlabs/gotez/v2/client` | Very limited Tezos RPC client library | +| `github.com/ecadlabs/gotez/v2/crypt` | A wrapper around standard and 3rd party signature algorithms which adds a support of Tezos encodings of keys and signatures | +| `github.com/ecadlabs/gotez/v2/encoding` | Tezos binary encoding library | +| `github.com/ecadlabs/gotez/v2/protocol` | Tezos binary protocol library | +| `github.com/ecadlabs/gotez/v2/teztool` | [Operation injection helper](teztool/README.md) | diff --git a/client/client.go b/client/client.go index d9830d4..034a5c5 100644 --- a/client/client.go +++ b/client/client.go @@ -1,3 +1,4 @@ +// Package client is a very limited Tezos RPC client library package client import ( diff --git a/crypt/common.go b/crypt/common.go index 8035913..a89a8f7 100644 --- a/crypt/common.go +++ b/crypt/common.go @@ -1,3 +1,4 @@ +// Package crypt is a wrapper around standard and 3rd party signature algorithms which adds a support of Tezos encodings of keys and signatures package crypt import ( diff --git a/encoding/common.go b/encoding/common.go index e980a17..50f0a91 100644 --- a/encoding/common.go +++ b/encoding/common.go @@ -1,3 +1,4 @@ +// Package encoding handles Tezos binary encoding package encoding import ( diff --git a/teztool/README.md b/teztool/README.md new file mode 100644 index 0000000..93d778f --- /dev/null +++ b/teztool/README.md @@ -0,0 +1,75 @@ +# teztool + +An operation injection helper + +## Example + +```go +package example + +import ( + "context" + "fmt" + "math/big" + + "github.com/ecadlabs/gotez/v2" + "github.com/ecadlabs/gotez/v2/b58" + "github.com/ecadlabs/gotez/v2/client" + "github.com/ecadlabs/gotez/v2/crypt" + "github.com/ecadlabs/gotez/v2/protocol/core" + "github.com/ecadlabs/gotez/v2/protocol/latest" + "github.com/ecadlabs/gotez/v2/teztool" +) + +type logger struct{} + +func (logger) Printf(format string, a ...any) { + fmt.Printf(format, a...) + fmt.Printf("\n") +} + +func TransferToWallet(url, chainID, address, privateKey string, amount *big.Int) (core.OperationsGroup, error) { + chain, err := b58.ParseChainID([]byte(chainID)) + if err != nil { + return nil, err + } + addr, err := b58.ParsePublicKeyHash([]byte(address)) + if err != nil { + return nil, err + } + c := client.Client{ + URL: url, + } + pk, err := b58.ParsePrivateKey([]byte(privateKey)) + if err != nil { + return nil, err + } + priv, err := crypt.NewPrivateKey(pk) + if err != nil { + return nil, err + } + + // initialize tezool + tool := teztool.New(&c, chain) + tool.DebugLogger = logger{} + + // initialize signer + signer := teztool.NewLocalSigner(priv) + + // make a transaction + val, err := gotez.NewBigUint(amount) + if err != nil { + // amount is negative + return nil, err + } + tx := latest.Transaction{ + ManagerOperation: latest.ManagerOperation{ + Source: priv.Public().Hash(), + }, + Amount: val, + Destination: core.ImplicitContract{PublicKeyHash: addr}, + } + + return tool.FillSignAndInjectWait(context.Background(), signer, []latest.OperationContents{&tx}, client.MetadataAlways, teztool.FillAll) +} +``` diff --git a/teztool/teztool.go b/teztool/teztool.go index eb17670..8a6965f 100644 --- a/teztool/teztool.go +++ b/teztool/teztool.go @@ -1,3 +1,4 @@ +// Package teztool is an operation injection helper package teztool import ( @@ -104,6 +105,7 @@ func (t *Tool) debug(format string, a ...any) { } } +// Fill fills requested missed fields like fee, counter, gas_limit, and storage_limit based on protocol constants, source contract state and the result of operation dry run func (t *Tool) Fill(ctx context.Context, group *latest.UnsignedOperation, attributes ...FillAttr) error { var attr fillAttrs for _, a := range attributes { @@ -377,6 +379,7 @@ func (t *Tool) scanBlock(ctx context.Context, hash *tz.BlockHash, op *tz.Operati return nil, nil } +// InjectAndWait injects the operation and waits for it to appear on chain func (t *Tool) InjectAndWait(ctx context.Context, req *client.InjectOperationRequest, meta client.MetadataMode) (core.OperationsGroup, error) { // open heads stream first headsCtx, headsCancel := context.WithCancel(ctx) @@ -454,6 +457,7 @@ func (t *Tool) injectionRequest(ctx context.Context, signer Signer, ops []latest }, nil } +// FillSignAndInject is an all in one function which fills missing fields and injects the operation without waiting func (t *Tool) FillSignAndInject(ctx context.Context, signer Signer, ops []latest.OperationContents, attributes ...FillAttr) (*tz.OperationHash, error) { req, err := t.injectionRequest(ctx, signer, ops, attributes...) if err != nil { @@ -463,6 +467,7 @@ func (t *Tool) FillSignAndInject(ctx context.Context, signer Signer, ops []lates return t.Client.InjectOperation(ctx, req) } +// FillSignAndInjectWait is an all in one function which fills missing fields, injects the operation and waits for it to appear on chain func (t *Tool) FillSignAndInjectWait(ctx context.Context, signer Signer, ops []latest.OperationContents, meta client.MetadataMode, attributes ...FillAttr) (core.OperationsGroup, error) { req, err := t.injectionRequest(ctx, signer, ops, attributes...) if err != nil {