package tezos-client-016-PtMumbai
Tezos/Protocol: protocol specific library for `tezos-client`
Install
Dune Dependency
Authors
Maintainers
Sources
tezos-17.3.tar.gz
sha256=7062cd57addd452852598a2214ade393130efa087b99068d53713bdf912b3680
sha512=08e4091144a03ce3c107fb91a66501bd8b65ca3278917c455a2eaac6df3e108ade63f6ab8340a4bb152d60f404326e464d0ec95d26cafe8e82f870465d24a5fc
doc/src/tezos-client-016-PtMumbai.commands/client_proto_fa12_commands.ml.html
Source file client_proto_fa12_commands.ml
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698(*****************************************************************************) (* *) (* Open Source License *) (* Copyright (c) 2020 Nomadic Labs <contact@nomadic-labs.com> *) (* *) (* Permission is hereby granted, free of charge, to any person obtaining a *) (* copy of this software and associated documentation files (the "Software"),*) (* to deal in the Software without restriction, including without limitation *) (* the rights to use, copy, modify, merge, publish, distribute, sublicense, *) (* and/or sell copies of the Software, and to permit persons to whom the *) (* Software is furnished to do so, subject to the following conditions: *) (* *) (* The above copyright notice and this permission notice shall be included *) (* in all copies or substantial portions of the Software. *) (* *) (* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR*) (* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, *) (* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL *) (* THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER*) (* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING *) (* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER *) (* DEALINGS IN THE SOFTWARE. *) (* *) (*****************************************************************************) open Protocol open Alpha_context open Client_proto_args let group = { Tezos_clic.name = "tokens"; title = "Commands for managing FA1.2-compatible smart contracts"; } let alias_param = Client_proto_contracts.ContractAlias.destination_param let token_contract_param () = Client_proto_contracts.OriginatedContractAlias.destination_param ~name:"contract" ~desc:"name or address of the FA1.2-compatible contract" let from_param () = alias_param ~name:"from" ~desc:"name or address of the sender" let to_param () = alias_param ~name:"to" ~desc:"name or address of the receiver" let amount_param () = Tezos_clic.param ~name:"amount" ~desc:"number of tokens" (Tezos_clic.parameter (fun _ s -> try let v = Z.of_string s in assert (Compare.Z.(v >= Z.zero)) ; Lwt_result_syntax.return v with _ -> failwith "invalid amount (must be a non-negative number)")) let tez_amount_arg = tez_arg ~default:"0" ~parameter:"tez-amount" ~doc:"amount in \xEA\x9C\xA9" let as_arg = Client_proto_contracts.ContractAlias.destination_arg ~name:"as" ~doc:"name or address of the caller of the contract" () let payer_arg = Client_keys.Public_key_hash.source_arg ~long:"payer" ~doc:"name of the payer (i.e. SOURCE) contract for the transaction" () let callback_entrypoint_arg = Tezos_clic.arg ~doc:"Entrypoint the view should use to callback to" ~long:"callback-entrypoint" ~placeholder:"name" string_parameter let contract_call_options = Tezos_clic.args9 tez_amount_arg fee_arg Client_proto_context_commands.dry_run_switch Client_proto_context_commands.verbose_signing_switch gas_limit_arg storage_limit_arg counter_arg no_print_source_flag fee_parameter_args let contract_view_options = Tezos_clic.args10 callback_entrypoint_arg tez_amount_arg fee_arg Client_proto_context_commands.dry_run_switch Client_proto_context_commands.verbose_signing_switch gas_limit_arg storage_limit_arg counter_arg no_print_source_flag fee_parameter_args let view_options = Tezos_clic.args3 run_gas_limit_arg payer_arg (unparsing_mode_arg ~default:"Readable") let dummy_callback = Contract.Implicit Tezos_crypto.Signature.Public_key_hash.zero let get_contract_caller_keys cctxt (caller : Contract.t) = let open Lwt_result_syntax in match caller with | Originated _ -> failwith "only implicit accounts can be the source of a contract call" | Implicit source -> let* _, caller_pk, caller_sk = Client_keys.get_key cctxt source in return (source, caller_pk, caller_sk) let commands_ro () : #Protocol_client_context.full Tezos_clic.command list = Tezos_clic. [ command ~group ~desc:"Check that a contract is FA1.2-compatible." no_options (prefixes ["check"; "contract"] @@ token_contract_param () @@ prefixes ["implements"; "fa1.2"] @@ stop) (fun () contract (cctxt : #Protocol_client_context.full) -> let open Lwt_result_syntax in let* _ = Client_proto_fa12.contract_has_fa12_interface cctxt ~chain:cctxt#chain ~block:cctxt#block ~contract () in Format.printf "Contract %a has an FA1.2 interface.\n%!" Contract_hash.pp contract ; return_unit); command ~group ~desc:"Ask for an address's balance offchain" view_options (prefixes ["from"; "fa1.2"; "contract"] @@ token_contract_param () @@ prefixes ["get"; "balance"; "for"] @@ alias_param ~name:"from" ~desc: "name or address of the account to lookup (also the source \ contract)" @@ stop) (fun (gas, payer, unparsing_mode) contract addr (cctxt : #Protocol_client_context.full) -> let open Lwt_syntax in let action = Client_proto_fa12.Get_balance (addr, (dummy_callback, None)) in let* res = Client_proto_fa12.run_view_action cctxt ~chain:cctxt#chain ~block:cctxt#block ~contract ~action ~source:addr ?gas ?payer ~unparsing_mode () in Client_proto_programs.print_view_result cctxt res); command ~group ~desc:"Ask for an address's allowance offchain" view_options (prefixes ["from"; "fa1.2"; "contract"] @@ token_contract_param () @@ prefixes ["get"; "allowance"; "on"] @@ alias_param ~name:"owner" ~desc:"name or address of the account giving the allowance" @@ prefix "as" @@ alias_param ~name:"operator" ~desc:"name or address of the account receiving the allowance" @@ stop) (fun (gas, payer, unparsing_mode) contract source destination (cctxt : #Protocol_client_context.full) -> let open Lwt_syntax in let action = Client_proto_fa12.Get_allowance (source, destination, (dummy_callback, None)) in let* res = Client_proto_fa12.run_view_action cctxt ~chain:cctxt#chain ~block:cctxt#block ~contract ~action ~source ?gas ?payer ~unparsing_mode () in Client_proto_programs.print_view_result cctxt res); command ~group ~desc:"Ask for the contract's total token supply offchain" view_options (prefixes ["from"; "fa1.2"; "contract"] @@ token_contract_param () @@ prefixes ["get"; "total"; "supply"] @@ stop) (fun (gas, payer, unparsing_mode) contract (cctxt : #Protocol_client_context.full) -> let open Lwt_syntax in let action = Client_proto_fa12.Get_total_supply (dummy_callback, None) in let* res = Client_proto_fa12.run_view_action cctxt ~chain:cctxt#chain ~block:cctxt#block ~contract ~action ?gas ?payer ~unparsing_mode () in Client_proto_programs.print_view_result cctxt res); command ~group ~desc:"Ask for an address's balance using a callback contract" contract_view_options (prefixes ["from"; "fa1.2"; "contract"] @@ token_contract_param () @@ prefixes ["get"; "balance"; "for"] @@ alias_param ~name:"from" ~desc: "name or address of the account to lookup (also the source \ contract)" @@ prefixes ["callback"; "on"] @@ alias_param ~name:"callback" ~desc:"name or address of the callback contract" @@ stop) (fun ( callback_entrypoint, tez_amount, fee, dry_run, verbose_signing, gas_limit, storage_limit, counter, no_print_source, fee_parameter ) contract addr callback (cctxt : #Protocol_client_context.full) -> let open Lwt_result_syntax in let* source, src_pk, src_sk = get_contract_caller_keys cctxt addr in let action = Client_proto_fa12.Get_balance (addr, (callback, callback_entrypoint)) in let*! errors = Client_proto_fa12.call_contract cctxt ~chain:cctxt#chain ~block:cctxt#block ~contract ~action ?confirmations:cctxt#confirmations ~dry_run ~verbose_signing ?fee ~source ~src_pk ~src_sk ~tez_amount ?gas_limit ?storage_limit ?counter ~fee_parameter () in let*! _ = Client_proto_context_commands.report_michelson_errors ~no_print_source ~msg:"transfer simulation failed" cctxt errors in return_unit); command ~group ~desc:"Ask for an address's allowance using a callback contract" contract_view_options (prefixes ["from"; "fa1.2"; "contract"] @@ token_contract_param () @@ prefixes ["get"; "allowance"; "on"] @@ alias_param ~name:"from" ~desc:"name or address of the account giving the allowance" @@ prefix "as" @@ alias_param ~name:"to" ~desc:"name or address of the account receiving the allowance" @@ prefixes ["callback"; "on"] @@ alias_param ~name:"callback" ~desc:"name or address of the callback contract" @@ stop) (fun ( callback_entrypoint, tez_amount, fee, dry_run, verbose_signing, gas_limit, storage_limit, counter, no_print_source, fee_parameter ) contract src dst callback (cctxt : #Protocol_client_context.full) -> let open Lwt_result_syntax in let* source, src_pk, src_sk = get_contract_caller_keys cctxt src in let action = Client_proto_fa12.Get_allowance (src, dst, (callback, callback_entrypoint)) in let*! errors = Client_proto_fa12.call_contract cctxt ~chain:cctxt#chain ~block:cctxt#block ~contract ~action ?confirmations:cctxt#confirmations ~dry_run ~verbose_signing ?fee ~source ~src_pk ~src_sk ~tez_amount ?gas_limit ?storage_limit ?counter ~fee_parameter () in let*! _ = Client_proto_context_commands.report_michelson_errors ~no_print_source ~msg:"transfer simulation failed" cctxt errors in return_unit); command ~group ~desc: "Ask for a contract's total token supply using a callback contract" contract_view_options (prefixes ["from"; "fa1.2"; "contract"] @@ token_contract_param () @@ prefixes ["get"; "total"; "supply"; "as"] @@ alias_param ~name:"from" ~desc:"name or address of the source account" @@ prefixes ["callback"; "on"] @@ alias_param ~name:"callback" ~desc:"name or address of the callback contract" @@ stop) (fun ( callback_entrypoint, tez_amount, fee, dry_run, verbose_signing, gas_limit, storage_limit, counter, no_print_source, fee_parameter ) contract addr callback (cctxt : #Protocol_client_context.full) -> let open Lwt_result_syntax in let* source, src_pk, src_sk = get_contract_caller_keys cctxt addr in let action = Client_proto_fa12.Get_total_supply (callback, callback_entrypoint) in let*! errors = Client_proto_fa12.call_contract cctxt ~chain:cctxt#chain ~block:cctxt#block ~contract ~action ?confirmations:cctxt#confirmations ~dry_run ~verbose_signing ?fee ~source ~src_pk ~src_sk ~tez_amount ?gas_limit ?storage_limit ?counter ~fee_parameter () in let*! _ = Client_proto_context_commands.report_michelson_errors ~no_print_source ~msg:"transfer simulation failed" cctxt errors in return_unit); ] let commands_rw () : #Protocol_client_context.full Tezos_clic.command list = let open Client_proto_args in Tezos_clic. [ command ~group ~desc:"Transfer tokens between two given accounts" (Tezos_clic.args10 as_arg tez_amount_arg fee_arg Client_proto_context_commands.dry_run_switch Client_proto_context_commands.verbose_signing_switch gas_limit_arg storage_limit_arg counter_arg no_print_source_flag fee_parameter_args) (prefixes ["from"; "fa1.2"; "contract"] @@ token_contract_param () @@ prefix "transfer" @@ amount_param () @@ prefix "from" @@ from_param () @@ prefix "to" @@ to_param () @@ stop ) (fun ( as_address, tez_amount, fee, dry_run, verbose_signing, gas_limit, storage_limit, counter, no_print_source, fee_parameter ) contract amount src dst (cctxt : #Protocol_client_context.full) -> let open Lwt_result_syntax in let caller = Option.value ~default:src as_address in let* source, caller_pk, caller_sk = get_contract_caller_keys cctxt caller in let action = Client_proto_fa12.Transfer (src, dst, amount) in let*! errors = Client_proto_fa12.call_contract cctxt ~chain:cctxt#chain ~block:cctxt#block ~contract ~action ?confirmations:cctxt#confirmations ~dry_run ~verbose_signing ?fee ~source ~src_pk:caller_pk ~src_sk:caller_sk ~tez_amount ?gas_limit ?storage_limit ?counter ~fee_parameter () in let*! _ = Client_proto_context_commands.report_michelson_errors ~no_print_source ~msg:"transfer simulation failed" cctxt errors in return_unit); command ~group ~desc:"Allow account to transfer an amount of token" contract_call_options (prefixes ["from"; "fa1.2"; "contract"] @@ token_contract_param () @@ prefix "as" @@ alias_param ~name:"as" ~desc:"name or address of the sender" @@ prefix "approve" @@ amount_param () @@ prefix "from" @@ alias_param ~name:"from" ~desc:"name or address to approve withdrawal" @@ stop) (fun ( tez_amount, fee, dry_run, verbose_signing, gas_limit, storage_limit, counter, no_print_source, fee_parameter ) contract source amount dst (cctxt : #Protocol_client_context.full) -> let open Lwt_result_syntax in let* source, src_pk, src_sk = get_contract_caller_keys cctxt source in let action = Client_proto_fa12.Approve (dst, amount) in let*! errors = Client_proto_fa12.call_contract cctxt ~chain:cctxt#chain ~block:cctxt#block ~contract ~action ?confirmations:cctxt#confirmations ~dry_run ~verbose_signing ?fee ~source ~src_pk ~src_sk ~tez_amount ?gas_limit ?storage_limit ?counter ~fee_parameter () in let*! _ = Client_proto_context_commands.report_michelson_errors ~no_print_source ~msg:"transfer simulation failed" cctxt errors in return_unit); command ~group ~desc: "Execute multiple token transfers from a single source account. If \ one of the token transfers fails, none of them are executed." (args9 default_fee_arg as_arg Client_proto_context_commands.dry_run_switch Client_proto_context_commands.verbose_signing_switch default_gas_limit_arg default_storage_limit_arg counter_arg no_print_source_flag fee_parameter_args) (prefixes ["multiple"; "fa1.2"; "transfers"; "from"] @@ alias_param ~name:"src" ~desc:"name or address of the source of the transfers" @@ prefix "using" @@ param ~name:"transfers.json" ~desc: (Format.sprintf "List of token transfers to inject from the source contract \ in JSON format (as a file or string). The JSON must be an \ array of objects of the form: '[ {\"token_contract\": \ address or alias, \"destination\": address or alias, \ \"amount\": non-negative integer (, <field>: <val> ...) } \ (, ...) ]', where an optional <field> can either be \ \"tez-amount\", \"fee\", \"gas-limit\" or \ \"storage-limit\". The complete schema can be inspected via \ `tezos-codec describe %s.fa1.2.token_transfer json schema`." Protocol.name) json_parameter @@ stop) (fun ( fee, as_address, dry_run, verbose_signing, gas_limit, storage_limit, counter, no_print_source, fee_parameter ) src operations_json cctxt -> let open Lwt_result_syntax in let caller = Option.value ~default:src as_address in match Data_encoding.Json.destruct (Data_encoding.list Client_proto_fa12.token_transfer_encoding) operations_json with | [] -> failwith "Empty operation list" | operations -> let* source, src_pk, src_sk = get_contract_caller_keys cctxt caller in let*! errors = Client_proto_fa12.inject_token_transfer_batch cctxt ~chain:cctxt#chain ~block:cctxt#block ?confirmations:cctxt#confirmations ~dry_run ~verbose_signing ~sender:src ~source ~src_pk ~src_sk ~token_transfers:operations ~fee_parameter ?counter ?default_fee:fee ?default_gas_limit:gas_limit ?default_storage_limit:storage_limit () in let*! _ = Client_proto_context_commands.report_michelson_errors ~no_print_source ~msg:"multiple transfers simulation failed" cctxt errors in return_unit | exception (Data_encoding.Json.Cannot_destruct (path, exn2) as exn) -> ( match (path, operations_json) with | [`Index n], `A lj -> ( match List.nth_opt lj n with | Some j -> failwith "Invalid transfer at index %i: %a %a" n (fun ppf -> Data_encoding.Json.print_error ppf) exn2 Data_encoding.Json.pp j | _ -> failwith "Invalid transfer at index %i: %a" n (fun ppf -> Data_encoding.Json.print_error ppf) exn2) | _ -> failwith "Invalid transfer file: %a %a" (fun ppf -> Data_encoding.Json.print_error ppf) exn Data_encoding.Json.pp operations_json)); ] let commands () = commands_ro () @ commands_rw ()